summaryrefslogtreecommitdiff
path: root/en/links.md
diff options
context:
space:
mode:
Diffstat (limited to 'en/links.md')
-rw-r--r--en/links.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/en/links.md b/en/links.md
new file mode 100644
index 0000000..2e600de
--- /dev/null
+++ b/en/links.md
@@ -0,0 +1,54 @@
+# Links (Coming Soon!)
+
+## Get a Link
+
+```shell
+curl "https://api.dc01.gamelockerapp.com/shards/na/link/{id}" \
+ -H "Authorization: Bearer <api-key>" \
+ -H "Accept: application/vnd.api+json"
+```
+
+This endpoint checks to see if a link object exists for a given code.
+
+### HTTP Request
+
+`GET https://api.dc01.gamelockerapp.com/link`
+
+### Query Parameters
+
+Parameter | Default | Description
+--------- | ------- | -----------
+
+## Post a Link
+
+```shell
+curl -XPOST "https://api.dc01.gamelockerapp.com/shards/na/link/{player_id}" \
+ -H "Authorization: Bearer <api-key>" \
+ -H "Accept: application/vnd.api+json"
+```
+
+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 | Default | Description
+--------- | ------- | -----------
+code | | The verification code
+
+## PlayerLink
+
+```json
+{
+ "attributes": {
+ "playerId": "fb374a7b-78be-4fcc-83ed-6a532a8a6f55",
+ "shardId": "na",
+ "titleId": "semc-vainglory"
+ },
+ "id": "2454e5ac-0a69-4468-ad12-8616f066e817",
+ "type": "playerLink"
+}
+```