API Overview
The public and partner API is contract-first. OpenAPI 3.1 is generated from workers/esim-api (M17).
- OpenAPI JSON: /openapi.json (regenerate with
pnpm --filter @traveler-labs/esim-api run openapi:generate) - Base URL:
https://<esim-api-host>/api/v1 - Partner auth:
X-Partner-Api-Key: <key> - Guest auth:
X-Guest-Token: <token>(from checkout response) - Market resolution:
X-Market-Idheader (optional; defaults to host-based market)
Surfaces
Section titled “Surfaces”| Surface | Prefix | Auth | In OpenAPI |
|---|---|---|---|
| Storefront | /api/v1/* | Guest token for orders/esims | Yes |
| Partner | /api/v1/partner/* | Partner API key | Yes |
| Admin | /api/v1/admin/* | JWT or internal key | No (Hono RPC) |
Errors
Section titled “Errors”Structured JSON: { "error": "<code>" }. Some eSIM routes include { "error", "reason" }.
See Reference for route groups and regeneration notes.