summaryrefslogtreecommitdiff
path: root/en/links.md
blob: 2e600de7ce1983be681738c3268c0f6a5d3aa68f (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
# 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"
}
```