summaryrefslogtreecommitdiff
path: root/source/links/links.rst
blob: 6ed57efa989689d65213422807231074e3a3a00c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
.. _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