diff options
Diffstat (limited to 'build/html/_sources/authorization/authorization.rst.txt')
| -rw-r--r-- | build/html/_sources/authorization/authorization.rst.txt | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/build/html/_sources/authorization/authorization.rst.txt b/build/html/_sources/authorization/authorization.rst.txt new file mode 100644 index 0000000..c61e51f --- /dev/null +++ b/build/html/_sources/authorization/authorization.rst.txt @@ -0,0 +1,73 @@ +.. _authorization: + +Authorization +============= + +We require a JSON Web Token `JWT <https://jwt.io/>`_. be sent along with your request via the Authorization header. +JWTs are passed as bearer tokens in the Authorization header, and look like the following: + +Authorization: <Enter your API Key> + +There's no need to create JWTs manually, they will be created for you when you register for the API - `Register Here! <https://developer.battlerite.com>`_. In some cases an X-API-KEY will give you more access to information, and in all cases it means that you are operating under a per-token rate limit. + +To specify the Headers, use this code: + +**Shell** + + +.. code-block:: shell + + //Shell + + # With shell, you can just pass the correct header with each request + curl "<endpoint-url>" \ + -H "Authorization: <api-key>" + -H "Accept: application/vnd.api+json" + + +.. code-block:: java + + //Java + + import java.io.*; + import java.net.*; + + URL url = new URL("<endpoint-url>"); + HttpURLConnection conn = (HttpURLConnection) url.openConnection(); + conn.setRequestMethod("GET"); + conn.setRequestProperty("Authorization","<api-key>"); + conn.setRequestProperty("Accept", "application/vnd.api+json"); + + conn.getInputStream() + + +.. code-block:: python + + //Python + + import requests + + url = "<endpoint-url>" + + header = { + "Authorization": "<api-key>", + "Accept": "application/vnd.api+json" + } + + r = requests.get(url, headers=header) + + +.. code-block:: go + + //Go + + import "net/http" + + client := &http.Client{} + req, _ := http.NewRequest("GET","<endpoint-url>",nil) + req.Header.Set("Authorization", "<api-key>") + req.Header.Set("Accept", "application/vnd.api+json") + res, _ := client.Do(req) + +.. toctree:: + :maxdepth: 2 |
