diff options
Diffstat (limited to 'build/html/makingrequests/makingrequests.html')
| -rw-r--r-- | build/html/makingrequests/makingrequests.html | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/build/html/makingrequests/makingrequests.html b/build/html/makingrequests/makingrequests.html new file mode 100644 index 0000000..2288995 --- /dev/null +++ b/build/html/makingrequests/makingrequests.html @@ -0,0 +1,267 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>Making Requests — Battelrite 0.2 documentation</title> + <link rel="stylesheet" href="../_static/css/battlerite.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '0.2', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Receiving Responses" href="../receivingresponses/receivingresponses.html" /> + <link rel="prev" title="Titles" href="../titles/titles.html" /> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> + </head> + <body> +<header id="BTT" role="banner"> + <div class="menu-top-outer clearfix"> + <div class="wrapper clearfix"> + <a href="/" id="site-logo"></a> + <span id="logSignBtn" class="btn">Login / Signup</span> + <nav id="mainMenu" class="main-menu-con"> + <ul class="main-menu clearfix"> + <li><a class="active" href="guides.html">Documentation</a></li> + <li><a href="faq.html">Faqs</a></li> + <li><a href="creations.html">Creations</a></li> + </ul> + </nav> + </div> + </div> +</header> + + <div class="related top"> + <nav id="rellinks"> + <ul> + <li> + ← + <a href="../titles/titles.html" title="Previous document">Titles</a> + </li> + <li> + <a href="../receivingresponses/receivingresponses.html" title="Next document">Receiving Responses</a> + → + </li> + </ul> + </nav> + <nav id="breadcrumbs"> + <ul> + <li><a href="../index.html">Battelrite 0.2 documentation</a></li> + </ul> + </nav> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="making-requests"> +<span id="makingrequests"></span><h1>Making Requests<a class="headerlink" href="#making-requests" title="Permalink to this headline">¶</a></h1> +<div class="section" id="content-negotiation"> +<h2>Content Negotiation<a class="headerlink" href="#content-negotiation" title="Permalink to this headline">¶</a></h2> +<p>Content Negotiation +Clients using the api should specify that they accept responses using the <code class="docutils literal"><span class="pre">application/vnd.api+json</span></code> format, for convenience we will also accept <code class="docutils literal"><span class="pre">application/json</span></code> since it is the default for many popular client libraries.</p> +<p>The Server will respond with a <code class="docutils literal"><span class="pre">Content-Type</span></code> header that mirrors the format requested by the Client.</p> +</div> +<div class="section" id="regions"> +<h2>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">¶</a></h2> +<p>The Vainglory Game Data Service currently supports the following regions:</p> +<p><em>General Region Shards:</em> To find data regarding live servers, where all data is found, please use the following shards.</p> +<ul class="simple"> +<li><strong>North America:</strong> <code class="docutils literal"><span class="pre">na</span></code></li> +<li><strong>Europe:</strong> <code class="docutils literal"><span class="pre">eu</span></code></li> +<li><strong>South America:</strong> <code class="docutils literal"><span class="pre">sa</span></code></li> +<li><strong>East Asia:</strong> <code class="docutils literal"><span class="pre">ea</span></code></li> +<li><strong>Southeast Asia (SEA):</strong> <code class="docutils literal"><span class="pre">sa</span></code></li> +</ul> +<p><em>Tournament Region Shards:</em> To find data regarding professional eSport, which take place on the private client only, please use the following shards.</p> +<ul class="simple"> +<li><strong>North America Tournaments:</strong> <code class="docutils literal"><span class="pre">tournament-na</span></code></li> +<li><strong>Europe Tournaments:</strong> <code class="docutils literal"><span class="pre">tournament-eu</span></code></li> +<li><strong>South America Tournaments:</strong> <code class="docutils literal"><span class="pre">tournament-sa</span></code></li> +<li><strong>East Asia Tournaments:</strong> <code class="docutils literal"><span class="pre">tournament-ea</span></code></li> +<li><strong>Southeast Asia Tournaments:</strong> <code class="docutils literal"><span class="pre">tournament-sg</span></code></li> +</ul> +<p><em>Please note: Choosing a specific region is currently required</em></p> +<p><strong>Javascript:</strong></p> +<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">To</span> <span class="nx">specify</span> <span class="nx">a</span> <span class="nx">region</span><span class="p">,</span> <span class="nx">use</span> <span class="k">this</span> <span class="nx">code</span><span class="o">:</span> + +<span class="s2">"...gamelockerapp.com/shards/<region>/..."</span> +</pre></div> +</div> +</div> +<div class="section" id="gzip"> +<h2>GZIP<a class="headerlink" href="#gzip" title="Permalink to this headline">¶</a></h2> +<p>Clients can specify the header <code class="docutils literal"><span class="pre">Accept-Encoding:</span> <span class="pre">gzip</span></code> and the server will compress responses. +Responses will be returns with <code class="docutils literal"><span class="pre">Content-Encoding:</span> <span class="pre">gzip</span></code>.</p> +<p>Given the size of matches, this can have significant performance benefits.</p> +<p><strong>Shell:</strong></p> +<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="nx">To</span> <span class="nx">specify</span> <span class="nx">the</span> <span class="nx">header</span> <span class="nx">Accept</span><span class="o">-</span><span class="nx">Encoding</span><span class="p">,</span> <span class="nx">use</span> <span class="k">this</span> <span class="nx">code</span><span class="o">:</span> + +<span class="o">-</span><span class="nx">H</span> <span class="s2">"Accept-Encoding: gzip"</span> +</pre></div> +</div> +<p><strong>Java:</strong></p> +<div class="highlight-java"><div class="highlight"><pre><span></span><span class="n">To</span> <span class="n">specify</span> <span class="n">the</span> <span class="n">header</span> <span class="n">Accept</span><span class="o">-</span><span class="n">Encoding</span><span class="o">,</span> <span class="n">use</span> <span class="k">this</span> <span class="n">code</span><span class="o">:</span> + +<span class="n">conn</span><span class="o">.</span><span class="na">setRequestProperty</span><span class="o">(</span><span class="s">"Accept-Encoding"</span><span class="o">,</span><span class="s">"gzip"</span><span class="o">);</span> +</pre></div> +</div> +<p><strong>Python:</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">To</span> <span class="n">specify</span> <span class="n">the</span> <span class="n">header</span> <span class="n">Accept</span><span class="o">-</span><span class="n">Encoding</span><span class="p">,</span> <span class="n">use</span> <span class="n">this</span> <span class="n">code</span><span class="p">:</span> + +<span class="n">header</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"Accept-Encoding"</span><span class="p">:</span><span class="s2">"gzip"</span><span class="p">}</span> +</pre></div> +</div> +<p><strong>Go:</strong></p> +<div class="highlight-go"><div class="highlight"><pre><span></span><span class="nx">To</span> <span class="nx">specify</span> <span class="nx">the</span> <span class="nx">header</span> <span class="nx">Accept</span><span class="o">-</span><span class="nx">Encoding</span><span class="p">,</span> <span class="nx">use</span> <span class="nx">this</span> <span class="nx">code</span><span class="p">:</span> + +<span class="nx">req</span><span class="p">.</span><span class="nx">Header</span><span class="p">.</span><span class="nx">Set</span><span class="p">(</span><span class="s">"Accept-Encoding"</span><span class="p">,</span> <span class="s">"gzip"</span><span class="p">)</span> +</pre></div> +</div> +</div> +<div class="section" id="pagination"> +<h2>Pagination<a class="headerlink" href="#pagination" title="Permalink to this headline">¶</a></h2> +<p>Where applicable, the server allows requests to limit the number of results returned via pagination. To paginate the primary data, supply pagination information to the query portion of the request using the limit and offset parameters. To fetch items 2 through 10 you would specify a limit of 8 and an offset of 2:</p> +<p>If not specified, the server will default for matches to <code class="docutils literal"><span class="pre">limit=5</span></code> and <code class="docutils literal"><span class="pre">offset=0</span></code>, and for players/samples to <code class="docutils literal"><span class="pre">limit=50</span></code> and <code class="docutils literal"><span class="pre">offset=0</span></code></p> +<blockquote> +<div><em>Important - Currently the server will not allow responses with over 50 primary data objects</em></div></blockquote> +</div> +<div class="section" id="search-time"> +<h2>Search Time<a class="headerlink" href="#search-time" title="Permalink to this headline">¶</a></h2> +<p><strong>Defaults:</strong></p> +<ul class="simple"> +<li>Data retention period: 120 days.</li> +<li>The max search time span between createdAt-start and createdAt-end: 28 days.</li> +<li>If you don’t specify createdAt-start, the default is now - 28 days.</li> +<li>If you don’t specify createdAt-end, the default is now.</li> +<li>If you search for a time > now, the default is now.</li> +<li>If you search for a time before the retention period, the default is the retention period (now - 120 days).</li> +<li>If createdAt-start >= createdAt-end, you will receive an error.</li> +</ul> +</div> +<div class="section" id="sorting"> +<h2>Sorting<a class="headerlink" href="#sorting" title="Permalink to this headline">¶</a></h2> +<p>The default sort order is always ascending. Ascending corresponds to the standard order of numbers and letters, i.e. A to Z, 0 to 9). For dates and times, ascending means that earlier values precede later ones e.g. 1/1/2000 will sort ahead of 1/1/2001.</p> +<p>All resource collections have a default sort order. In addition, some resources provide the ability to sort according to one or more criteria (“sort fields”).</p> +<p>If sort fields are is prefixed with a minus, the order will be changed to descending.</p> +<p><strong>Javascript</strong></p> +<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="c1">//The example below will return the oldest articles first:</span> +<span class="s2">".../matches?sort=createdAt"</span> + +<span class="c1">//The example below will return the newest articles first:</span> +<span class="s2">".../matches?sort=-createdAt"</span> +</pre></div> +</div> +</div> +<div class="section" id="json-p-callbacks"> +<h2>JSON-P Callbacks<a class="headerlink" href="#json-p-callbacks" title="Permalink to this headline">¶</a></h2> +<p>You can send a <code class="docutils literal"><span class="pre">?callback</span></code> parameter to any GET call to have the results wrapped in a JSON function. This is typically used when browsers want to embed content in web pages by getting around cross domain issues. The response includes the same data output as the regular API, plus the relevant HTTP Header information.</p> +<p><strong>Shell:</strong></p> +<div class="highlight-shell"><div class="highlight"><pre><span></span>curl -g <span class="s2">"https://api.dc01.gamelockerapp.com/status?callback=foo"</span> +</pre></div> +</div> +</div> +<div class="section" id="cross-origin-resource-sharing"> +<h2>Cross Origin Resource Sharing<a class="headerlink" href="#cross-origin-resource-sharing" title="Permalink to this headline">¶</a></h2> +<p>This is what the CORS preflight request looks like. The API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. You can read the CORS W3C Recommendation, or this intro from the HTML 5 Security Guide.</p> +<p>Here’s a sample request sent from a browser hitting <a class="reference external" href="http://example.com">http://example.com</a>:</p> +<p><strong>Shell:</strong></p> +<div class="highlight-shell"><div class="highlight"><pre><span></span>curl -i https://api.dc01.gamelockerapp.com/status -H <span class="s2">"Origin: http://example.com"</span> +HTTP/1.1 <span class="m">200</span> OK +... +Access-Control-Allow-Origin: * +Access-Control-Expose-Headers: Content-Length + +This is what the CORS preflight request looks like: + +curl -i https://api.dc01.gamelockerapp.com/status -H <span class="s2">"Origin: http://example.com"</span> -X OPTIONS +HTTP/1.1 <span class="m">200</span> OK +... +Access-Control-Allow-Headers: Origin,X-Title-Id,Authorization +Access-Control-Allow-Methods: GET,POST,OPTIONS +Access-Control-Allow-Origin: * +Access-Control-Max-Age: <span class="m">86400</span> +</pre></div> +</div> +<div class="toctree-wrapper compound"> +</div> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h3><a href="../index.html">Table Of Contents</a></h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li> +<li class="toctree-l1"><a class="reference internal" href="../datacenters/datacenters.html">Datacenters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../authorization/authorization.html">Authorization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../titles/titles.html">Titles</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Making Requests</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#content-negotiation">Content Negotiation</a></li> +<li class="toctree-l2"><a class="reference internal" href="#regions">Regions</a></li> +<li class="toctree-l2"><a class="reference internal" href="#gzip">GZIP</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pagination">Pagination</a></li> +<li class="toctree-l2"><a class="reference internal" href="#search-time">Search Time</a></li> +<li class="toctree-l2"><a class="reference internal" href="#sorting">Sorting</a></li> +<li class="toctree-l2"><a class="reference internal" href="#json-p-callbacks">JSON-P Callbacks</a></li> +<li class="toctree-l2"><a class="reference internal" href="#cross-origin-resource-sharing">Cross Origin Resource Sharing</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../receivingresponses/receivingresponses.html">Receiving Responses</a></li> +<li class="toctree-l1"><a class="reference internal" href="../matches/matches.html">Matches</a></li> +<li class="toctree-l1"><a class="reference internal" href="../match_data_summary/match_data_summary.html">Match Data Summary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../players/players.html">Players</a></li> +<li class="toctree-l1"><a class="reference internal" href="../samples/samples.html">Samples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../telemetry/telemetry.html">Telemetry</a></li> +<li class="toctree-l1"><a class="reference internal" href="../teams/teams.html">Teams</a></li> +<li class="toctree-l1"><a class="reference internal" href="../links/links.html">Links</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community_sdks/community_sdks.html">Community SDKs</a></li> +<li class="toctree-l1"><a class="reference internal" href="../errors/errors.html">Errors</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog/changelog.html">Changelog</a></li> +</ul> + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related bottom"> + <nav id="rellinks"> + <ul> + <li> + ← + <a href="../titles/titles.html" title="Previous document">Titles</a> + </li> + <li> + <a href="../receivingresponses/receivingresponses.html" title="Next document">Receiving Responses</a> + → + </li> + </ul> + </nav> + <nav id="breadcrumbs"> + <ul> + <li><a href="../index.html">Battelrite 0.2 documentation</a></li> + </ul> + </nav> + </div> + + </body> +</html>
\ No newline at end of file |