Blame
|
1 | # SDKs |
||||||
| 2 | ||||||||
|
3 | SDKs provide language-specific tools for working with AeThex APIs and platform services. |
||||||
|
4 | |||||||
|
5 | <div class="docs-section-heading"> |
||||||
| 6 | <h2>SDK purpose</h2> |
|||||||
| 7 | <p>SDKs should make common integrations easier while preserving the behavior documented in the API Reference.</p> |
|||||||
| 8 | </div> |
|||||||
|
9 | |||||||
|
10 | SDKs should wrap authentication, request signing, pagination, error handling, retry behavior, and typed access to common resources. They should not hide important security or permission requirements. |
||||||
| 11 | ||||||||
| 12 | ## SDK responsibilities |
|||||||
| 13 | ||||||||
| 14 | - Authenticate with supported AeThex credentials. |
|||||||
| 15 | - Provide typed clients for stable API resources. |
|||||||
| 16 | - Handle pagination and common errors. |
|||||||
| 17 | - Respect [[Rate-Limits]]. |
|||||||
| 18 | - Offer examples for common workflows. |
|||||||
| 19 | ||||||||
| 20 | ## Documentation pattern |
|||||||
| 21 | ||||||||
| 22 | Each SDK should include: |
|||||||
| 23 | ||||||||
| 24 | 1. Install instructions. |
|||||||
| 25 | 2. Authentication setup. |
|||||||
| 26 | 3. Minimal working example. |
|||||||
| 27 | 4. Common operations. |
|||||||
| 28 | 5. Error and retry behavior. |
|||||||
| 29 | 6. Version compatibility notes. |
|||||||
| 30 | ||||||||
| 31 | <div class="docs-grid"> |
|||||||
| 32 | <a class="docs-card" href="/Api-Reference">API Reference</a> |
|||||||
| 33 | <a class="docs-card" href="/Authentication">Authentication</a> |
|||||||
| 34 | <a class="docs-card" href="/CLI">CLI</a> |
|||||||
| 35 | <a class="docs-card" href="/Webhooks">Webhooks</a> |
|||||||
| 36 | </div> |
|||||||