Blame
|
1 | # API Reference |
||||||
| 2 | ||||||||
|
3 | This page describes the expected structure of AeThex APIs. |
||||||
|
4 | |||||||
|
5 | > [!NOTE] |
||||||
| 6 | > Endpoint names may vary by active service. Use this as a contract guide until individual service references are published. |
|||||||
|
7 | |||||||
| 8 | --- |
|||||||
| 9 | ||||||||
|
10 | ## Base Concepts |
||||||
|
11 | |||||||
|
12 | AeThex APIs generally use: |
||||||
|
13 | |||||||
|
14 | - HTTPS JSON requests |
||||||
| 15 | - Bearer tokens or API keys |
|||||||
| 16 | - Scoped permissions |
|||||||
| 17 | - Structured error objects |
|||||||
| 18 | - Webhooks for async events |
|||||||
|
19 | |||||||
|
20 | --- |
||||||
|
21 | |||||||
|
22 | ## Common Resources |
||||||
|
23 | |||||||
|
24 | | Resource | Purpose | |
||||||
| 25 | |---|---| |
|||||||
| 26 | | /auth | Authentication and token exchange | |
|||||||
| 27 | | /passport | User identity and profile context | |
|||||||
| 28 | | /accounts | Linked account references | |
|||||||
| 29 | | /projects | Creator/developer projects | |
|||||||
| 30 | | /games | Game and experience integration | |
|||||||
| 31 | | /locker | Inventory and asset context | |
|||||||
| 32 | | /webhooks | Event subscription management | |
|||||||
|
33 | |||||||
| 34 | --- |
|||||||
| 35 | ||||||||
|
36 | ## Example Response Shape |
||||||
| 37 | ||||||||
| 38 | ```json |
|||||||
| 39 | { |
|||||||
| 40 | "ok": true, |
|||||||
| 41 | "data": {}, |
|||||||
| 42 | "requestId": "req_..." |
|||||||
| 43 | } |
|||||||
| 44 | ``` |
|||||||
| 45 | ||||||||
| 46 | ## Example Error Shape |
|||||||
| 47 | ||||||||
| 48 | ```json |
|||||||
| 49 | { |
|||||||
| 50 | "ok": false, |
|||||||
| 51 | "error": { |
|||||||
| 52 | "code": "unauthorized", |
|||||||
| 53 | "message": "Missing or invalid credentials" |
|||||||
| 54 | }, |
|||||||
| 55 | "requestId": "req_..." |
|||||||
| 56 | } |
|||||||
| 57 | ``` |
|||||||
|
58 | |||||||
|
59 | --- |
||||||
|
60 | |||||||
|
61 | ## Related |
||||||
|
62 | |||||||
|
63 | - [[Authentication]] |
||||||
| 64 | - [[SDKs]] |
|||||||
| 65 | - [[Webhooks]] |
|||||||
| 66 | - [[Rate-Limits]] |
|||||||