Minden végpont application/json választ ad. A hibák az RFC 7807 (Problem+JSON) szabványt követik. Minden válasz X-Request-Id fejlécet tartalmaz a szerveroldali audit-naplóval való összevetéshez.
| Method | Path | Jogosultság | Cél |
|---|---|---|---|
| GET | /v1/health | public | Hitelesítés nélküli állapot-ellenőrzés. |
| GET | /v1/me | any | Saját fiókinformáció és kulcs metaadatok. |
| GET | /v1/products | read:products | Minden nyilvánosan listázott termék listája árakkal. |
| GET | /v1/products/{id} | read:products | Termékadatok, beleértve a konfigurációs opciókat. |
| POST | /v1/orders | write:orders | Megrendelés leadása. Idempotency-Key kötelező. |
| GET | /v1/orders/{id} | read:orders | Saját megrendelés állapota. |
| GET | /v1/services | read:services | Saját szolgáltatások listája (lapozott). |
| GET | /v1/services/{id} | read:services | Saját szolgáltatás részletei. |
| GET | /v1/services/{id}/credentials | read:credentials | Szolgáltatási hozzáférési adatok (külön jogosultság, audit-naplózott). |
| POST | /v1/services/{id}/actions | write:services | Szolgáltatási művelet: start, stop, reboot, cancel (a számlázási időszak végére), cancel_revoke. |
| GET | /v1/billing/balance | read:billing | Egyenleg. |
| GET | /v1/billing/invoices | read:billing | Saját számlák listája (lapozott). |
| GET | /v1/billing/invoices/{id}/pdf | read:billing | Számla PDF. |
| GET | /v1/webhooks | read:webhooks | Aktuális webhook URL. |
| PUT | /v1/webhooks | write:webhooks | Webhook URL beállítása vagy törlése. |
Idempotencia
A POST /v1/orders és a POST /v1/services/{id}/actions kérésekhez Idempotency-Key fejléc szükséges (1 és 80 karakter közötti hosszúságú érték az [A-Za-z0-9_.-] karakterkészletből). A kulcs a metódushoz, az útvonalhoz és a törzshöz kötött. Ha ugyanazt a kérést egy órán belül ugyanazzal a kulccsal megismétli, a tárolt választ kapja vissza; egy óra elteltével viszont 410-es választ kap (reason: replay_stale), ilyenkor küldjön új kulcsot. Ha ugyanazt a kulcsot eltérő törzzsel vagy másik végponton használja, a szerver 409 idempotency_conflict hibával elutasítja a kérést.
Sebességkorlátok
Az alapértelmezett korlátok: kulcsonként percenként 60 kérés (plusz 20 kérésnyi burst) és naponta 5000 kérés, fiókonként az összes kulcsra együtt percenként 120 kérés, forrás-IP-címenként pedig percenként 600 kérés. Bármely korlát túllépésekor HTTP 429 választ kap Retry-After fejléccel. Az X-RateLimit-Remaining és az X-RateLimit-Reset válaszfejléc a kulcsonkénti korlát aktuális állását mutatja.
