Skip to content

Commit 4f0c0f7

Browse files
davidbmaierdavidbmaier
committed
Update endpoints for January API changes
1 parent e392c74 commit 4f0c0f7

16 files changed

+956
-430
lines changed

‎docs/core/accounts/webidentities-account.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
name: Get player webIdentities
3+
4+
url: https://prod.trackmania.core.nadeo.online
5+
method: GET
6+
route: /webidentities/by-account/?accountIdList={accountIdList}
7+
8+
audience: NadeoServices
9+
10+
parameters:
11+
query:
12+
- name: accountIdList
13+
type: string
14+
description: A comma-separated list of account IDs
15+
required: true
16+
---
17+
18+
<div class="notification is-info">
19+
20+
This endpoint is not the same as the [deprecated webidentities endpoint](/core/deprecated/webidentities) - note the changed endpoint route.
21+
22+
</div>
23+
24+
Gets player webIdentities from account IDs
25+
26+
---
27+
28+
**Remarks**:
29+
30+
- The `timestamp` field is the creation date of the account - effectively the date when the account started playing Trackmania.
31+
- Due to the `ubiServices` and `uplay` providers being handled separately (potentially for historical reasons), there are typically two objects for each requested account. They will otherwise be identical.
32+
- This endpoint behaves the same as the [deprecated webidentities endpoint](/core/deprecated/webidentities).
33+
34+
---
35+
36+
**Example request**:
37+
38+
```plain
39+
GET https://prod.trackmania.core.nadeo.online/webidentities/by-account/?accountIdList=5b4d42f4-c2de-407d-b367-cbff3fe817bc,7398eeb6-9b4e-44b8-a7a1-a2149955ac70
40+
```
41+
42+
**Example response**:
43+
44+
```json
45+
[
46+
{
47+
"accountId": "5b4d42f4-c2de-407d-b367-cbff3fe817bc",
48+
"provider": "ubiServices",
49+
"uid": "a59df3e8-6bff-48a2-98b6-801abf2a298e",
50+
"timestamp": "2020-07-01T15:05:34+00:00"
51+
},
52+
{
53+
"accountId": "5b4d42f4-c2de-407d-b367-cbff3fe817bc",
54+
"provider": "uplay",
55+
"uid": "a59df3e8-6bff-48a2-98b6-801abf2a298e",
56+
"timestamp": "2020-07-01T15:05:34+00:00"
57+
},
58+
{
59+
"accountId": "7398eeb6-9b4e-44b8-a7a1-a2149955ac70",
60+
"provider": "ubiServices",
61+
"uid": "1ad088a9-4a99-43b7-a0a7-add68e3ac974",
62+
"timestamp": "2020-06-05T19:32:19+00:00"
63+
},
64+
{
65+
"accountId": "7398eeb6-9b4e-44b8-a7a1-a2149955ac70",
66+
"provider": "uplay",
67+
"uid": "1ad088a9-4a99-43b7-a0a7-add68e3ac974",
68+
"timestamp": "2020-06-05T19:32:19+00:00"
69+
}
70+
]
71+
```
72+
73+
If an `accountId` is invalid, the response will contain an error message:
74+
75+
```json
76+
{
77+
"code": "C-AA-00-03",
78+
"correlation_id": "16749c9cd157abf072db92319bdc51f1",
79+
"message": "There was a validation error.",
80+
"info": {
81+
"accountIdList": "Invalid account id."
82+
}
83+
}
84+
```

docs/core/maps/info-multiple.md renamed to docs/core/deprecated/info-multiple.md

Lines changed: 107 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,107 @@
1-
---
2-
name: Get map info (multiple)
3-
4-
url: https://prod.trackmania.core.nadeo.online
5-
method: GET
6-
route: /maps/?mapIdList={mapIdList}&mapUidList={mapUidList}
7-
8-
audience: NadeoServices
9-
10-
parameters:
11-
query:
12-
- name: mapIdList
13-
type: string
14-
description: A comma-separated list of map IDs
15-
required: true
16-
- name: mapUidList
17-
type: string
18-
description: A comma-separated list of map UIDs
19-
required: true
20-
---
21-
22-
Gets information about multiple maps via their IDs/UIDs.
23-
24-
---
25-
26-
**Remarks**:
27-
28-
- The two parameters work the same way, but you can only use one of them at a time.
29-
- This endpoint has no intrinsic limit on the number of map IDs requested, but it will return a `414` error if the request URI length is 8220 characters or more (corresponding to just over 200 map IDs or almost 300 map UIDs, depending on how you encode the URI).
30-
31-
---
32-
33-
**Example request**:
34-
35-
```plain
36-
GET https://prod.trackmania.core.nadeo.online/maps/?mapUidList=k45jQI6Y7XrPfe1T0hZhj4pKzY2,cmJJhEUYqesM6Tqpeds0lQudvOb
37-
```
38-
39-
**Example response**:
40-
41-
```json
42-
[
43-
{
44-
"author": "73eba009-a074-4439-916f-d25d7fa7bc1c",
45-
"authorScore": 102399,
46-
"bronzeScore": 154000,
47-
"collectionName": "Stadium",
48-
"createdWithGamepadEditor": false,
49-
"createdWithSimpleEditor": false,
50-
"filename": "Laserhawk_-_Megacity_Race.Map.Gbx",
51-
"goldScore": 109000,
52-
"isPlayable": true,
53-
"mapId": "a74716be-d124-4de1-87c2-834304ccef5b",
54-
"mapStyle": "",
55-
"mapType": "TrackMania\\TM_Race",
56-
"mapUid": "cmJJhEUYqesM6Tqpeds0lQudvOb",
57-
"name": "$i$a1bLaserhawk $fff- Megacity Race",
58-
"silverScore": 123000,
59-
"submitter": "7ad33388-641e-4497-b063-c88e75552645",
60-
"timestamp": "2023-10-23T17:05:25+00:00",
61-
"fileUrl": "https://core.trackmania.nadeo.live/storageObjects/6d67fafb-1be8-451a-91ca-661e019a9087",
62-
"thumbnailUrl": "https://core.trackmania.nadeo.live/storageObjects/70e82469-68b6-454a-a105-2af7c3279a4c.jpg"
63-
},
64-
{
65-
"author": "7cd60a75-609a-4e64-b286-16f329878249",
66-
"authorScore": 26972,
67-
"bronzeScore": 41000,
68-
"collectionName": "Stadium",
69-
"createdWithGamepadEditor": false,
70-
"createdWithSimpleEditor": false,
71-
"filename": "SnowIsBack.Map.Gbx",
72-
"goldScore": 29000,
73-
"isPlayable": true,
74-
"mapId": "5546883f-b1ed-49e0-9397-55fc46f1d00c",
75-
"mapStyle": "",
76-
"mapType": "TrackMania\\TM_Race",
77-
"mapUid": "k45jQI6Y7XrPfe1T0hZhj4pKzY2",
78-
"name": "SnowIsBack",
79-
"silverScore": 33000,
80-
"submitter": "7cd60a75-609a-4e64-b286-16f329878249",
81-
"timestamp": "2023-11-21T16:50:01+00:00",
82-
"fileUrl": "https://core.trackmania.nadeo.live/storageObjects/5b244c36-da6d-45f2-bbd3-c97ed4b5efc0",
83-
"thumbnailUrl": "https://core.trackmania.nadeo.live/storageObjects/647ea926-6959-439e-a6e2-e7a78caa9529.jpg"
84-
}
85-
]
86-
```
87-
88-
If a `mapId` is invalid, the response will contain an error message:
89-
90-
```json
91-
{
92-
"code": "C-AA-00-03",
93-
"correlation_id": "10d26dadac018cccf1c9bcf138e3fb1c",
94-
"message": "There was a validation error.",
95-
"info": {
96-
"mapIdList": "Invalid uuid."
97-
}
98-
}
99-
```
100-
101-
If a `mapUid` is invalid, that map will not be returned in the response.
1+
---
2+
name: Get map info (multiple)
3+
4+
url: https://prod.trackmania.core.nadeo.online
5+
method: GET
6+
route: /maps/?mapIdList={mapIdList}&mapUidList={mapUidList}
7+
8+
audience: NadeoServices
9+
10+
parameters:
11+
query:
12+
- name: mapIdList
13+
type: string
14+
description: A comma-separated list of map IDs
15+
required: true
16+
- name: mapUidList
17+
type: string
18+
description: A comma-separated list of map UIDs
19+
required: true
20+
---
21+
22+
<div class="notification is-warning">
23+
24+
This endpoint is deprecated and may be removed in the future. Use the [info (ID)](/core/maps/info-multiple-id) or [info (UID)](/core/maps/info-multiple-uid) endpoints instead.
25+
26+
</div>
27+
28+
Gets information about multiple maps via their IDs/UIDs.
29+
30+
---
31+
32+
**Remarks**:
33+
34+
- The two parameters work the same way, but you can only use one of them at a time.
35+
- This endpoint has no intrinsic limit on the number of map IDs requested, but it will return a `414` error if the request URI length is 8220 characters or more (corresponding to just over 200 map IDs or almost 300 map UIDs, depending on how you encode the URI).
36+
37+
---
38+
39+
**Example request**:
40+
41+
```plain
42+
GET https://prod.trackmania.core.nadeo.online/maps/?mapUidList=k45jQI6Y7XrPfe1T0hZhj4pKzY2,cmJJhEUYqesM6Tqpeds0lQudvOb
43+
```
44+
45+
**Example response**:
46+
47+
```json
48+
[
49+
{
50+
"author": "73eba009-a074-4439-916f-d25d7fa7bc1c",
51+
"authorScore": 102399,
52+
"bronzeScore": 154000,
53+
"collectionName": "Stadium",
54+
"createdWithGamepadEditor": false,
55+
"createdWithSimpleEditor": false,
56+
"filename": "Laserhawk_-_Megacity_Race.Map.Gbx",
57+
"goldScore": 109000,
58+
"isPlayable": true,
59+
"mapId": "a74716be-d124-4de1-87c2-834304ccef5b",
60+
"mapStyle": "",
61+
"mapType": "TrackMania\\TM_Race",
62+
"mapUid": "cmJJhEUYqesM6Tqpeds0lQudvOb",
63+
"name": "$i$a1bLaserhawk $fff- Megacity Race",
64+
"silverScore": 123000,
65+
"submitter": "7ad33388-641e-4497-b063-c88e75552645",
66+
"timestamp": "2023-10-23T17:05:25+00:00",
67+
"fileUrl": "https://core.trackmania.nadeo.live/storageObjects/6d67fafb-1be8-451a-91ca-661e019a9087",
68+
"thumbnailUrl": "https://core.trackmania.nadeo.live/storageObjects/70e82469-68b6-454a-a105-2af7c3279a4c.jpg"
69+
},
70+
{
71+
"author": "7cd60a75-609a-4e64-b286-16f329878249",
72+
"authorScore": 26972,
73+
"bronzeScore": 41000,
74+
"collectionName": "Stadium",
75+
"createdWithGamepadEditor": false,
76+
"createdWithSimpleEditor": false,
77+
"filename": "SnowIsBack.Map.Gbx",
78+
"goldScore": 29000,
79+
"isPlayable": true,
80+
"mapId": "5546883f-b1ed-49e0-9397-55fc46f1d00c",
81+
"mapStyle": "",
82+
"mapType": "TrackMania\\TM_Race",
83+
"mapUid": "k45jQI6Y7XrPfe1T0hZhj4pKzY2",
84+
"name": "SnowIsBack",
85+
"silverScore": 33000,
86+
"submitter": "7cd60a75-609a-4e64-b286-16f329878249",
87+
"timestamp": "2023-11-21T16:50:01+00:00",
88+
"fileUrl": "https://core.trackmania.nadeo.live/storageObjects/5b244c36-da6d-45f2-bbd3-c97ed4b5efc0",
89+
"thumbnailUrl": "https://core.trackmania.nadeo.live/storageObjects/647ea926-6959-439e-a6e2-e7a78caa9529.jpg"
90+
}
91+
]
92+
```
93+
94+
If a `mapId` is invalid, the response will contain an error message:
95+
96+
```json
97+
{
98+
"code": "C-AA-00-03",
99+
"correlation_id": "10d26dadac018cccf1c9bcf138e3fb1c",
100+
"message": "There was a validation error.",
101+
"info": {
102+
"mapIdList": "Invalid uuid."
103+
}
104+
}
105+
```
106+
107+
If a `mapUid` is invalid, that map will not be returned in the response.

0 commit comments

Comments
 (0)