diff options
| author | Ken <kenny@madgloryint.com> | 2017-11-01 13:27:17 -0400 |
|---|---|---|
| committer | Ken <kenny@madgloryint.com> | 2017-11-01 13:27:17 -0400 |
| commit | 1385a3cefc7312a3f18e8d78a854411b53c75e67 (patch) | |
| tree | f27292fc20215f68c25ab09830947da56fb732a9 /build/html/_sources/links/links.rst.txt | |
| parent | 0f19a09673be2bb79426e21a6460d5095f43287a (diff) | |
| download | vainglory-docs-1385a3cefc7312a3f18e8d78a854411b53c75e67.tar.gz vainglory-docs-1385a3cefc7312a3f18e8d78a854411b53c75e67.zip | |
Initial commit of the new logs.
Diffstat (limited to 'build/html/_sources/links/links.rst.txt')
| -rw-r--r-- | build/html/_sources/links/links.rst.txt | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/build/html/_sources/links/links.rst.txt b/build/html/_sources/links/links.rst.txt new file mode 100644 index 0000000..5e0dc4e --- /dev/null +++ b/build/html/_sources/links/links.rst.txt @@ -0,0 +1,69 @@ +.. _links: + +Links +====== + +Get a Link +--------------------------- + +This endpoint checks to see if a link object exists for a given code. + +**HTTP Request:** + +| ``GET https://api.dc01.gamelockerapp.com/link`` + +**Shell:** + +.. code-block:: shell + + curl "https://api.dc01.gamelockerapp.com/shards/na/link/{id}" \ + -H "Authorization: Bearer <api-key>" \ + -H "Accept: application/vnd.api+json" + + + +Post a Link +--------------------------- + +This endpoint creates a PlayerLink object if the verification code matches the one provided by the game. + +**HTTP Request:** + +| ``POST https://api.dc01.gamelockerapp.com/link/{player_id}`` + + +**Query Parameters:** + +| ``Parameter: Code`` +| + +**Shell:** + +.. code-block:: shell + + curl -XPOST "https://api.dc01.gamelockerapp.com/shards/na/link/{player_id}" \ + -H "Authorization: Bearer <api-key>" \ + -H "Accept: application/vnd.api+json" + + + + +Player Link +--------------------------- + +**Shell:** + +.. code-block:: shell + + { + "attributes": { + "playerId": "fb374a7b-78be-4fcc-83ed-6a532a8a6f55", + "shardId": "na", + "titleId": "semc-vainglory" + }, + "id": "2454e5ac-0a69-4468-ad12-8616f066e817", + "type": "playerLink" + } + +.. toctree:: + :maxdepth: 2 |
