REST API
Kommer snartAPI-referens
Den fullständiga API-referensen kommer att auto-genereras från vår OpenAPI 3.1-spec så fort surface är stabil. Vi shippar hellre en placeholder än fake-dokar endpoints som fortfarande kan röra sig. Under tiden, här är formen, vad den kommer täcka och vad du gör idag.
Form (kan ändras)
REST över HTTPS. JSON in, JSON ut. Bearer-token-auth på varje request. Versionerad i path:en: /v1/.... Rate-limited per token; svaret bär de vanliga X-RateLimit-*-headers.
curl 1# varje endpoint tar en API-nyckel i Authorization-headern2curl https://api.sonenta.com/v1/projects \3 -H "Authorization: ApiKey snt_live_<prefix>.<secret>" 5{ "data": [{ "id": "proj_xxx", "name": "Checkout", … }] } API-nycklar kommer från Org Settings → API Keys i dashboarden. Samma nyckel funkar för CLI:n, MCP-servern och direkta REST-anrop — API:n konsumerar bara bearern.
Resurser vid lansering
Detta är resurserna som V1-API:n kommer att exponera. Den exakta formen — fält, felkoder, paginering — landar när vi publicerar OpenAPI-specen.
| Resurs | Vad den representerar | V1-ops |
|---|---|---|
| Projects | Workspaces. Skapa, lista, arkivera, överför ownership. | GET · POST · PATCH · DELETE |
| Locales | Projekt-scoped locale-set. Lägg till en locale, markera som default, aktivera/inaktivera för klienter. | GET · POST · PATCH · DELETE |
| Namespaces | Logiska hinkar av nycklar per projekt (t.ex. "checkout", "common"). | GET · POST · PATCH · DELETE |
| Keys | Översättningsnycklar med beskrivning, screenshot-URL:er, max-length, pluralregler. | GET · POST · PATCH · DELETE |
| Translations | Värde per locale för en nyckel. Draft-, in-review-, approved-states; revisionshistorik. | GET · POST · PATCH · DELETE |
| Missing keys | Runtime-SDK:ns kö. Lista, gruppera på frekvens, markera som triagerad. | GET · PATCH |
| Webhooks | Prenumerera på översättningsevents. V2. | V2 |
Vad du gör idag
Nästan allt du skulle vilja nå API:n för är redan exponerat via CLI:n, MCP-servern eller runtime-SDK:n. Använd dem — när API:n landar kan din kod byta till direkta HTTP-anrop utan att ändra vad den faktiskt gör.
Live OpenAPI för early devs
Om du kör Sonenta-backenden lokalt exponeras den live OpenAPI 3.1-specen på:
lokal backend Peka Stoplight, Swagger UI, Insomnia, Postman eller valfritt OpenAPI-medvetet verktyg på den URL:en. Formen rör sig — det är därför sidan är en placeholder — men det är källan till sanning just nu om du vill utforska endpoints tidigt.
När landar den publika referensen?
Den publika OpenAPI-specen kommer att serveras på https://api.sonenta.com/openapi.json så fort V1-surface är fryst. Därifrån byter den här sidan från placeholder till en fullt renderad referens (Stoplight eller liknande viewer över specen) — ingen marknadsföringstext, bara varje endpoint, varje payload, varje felkod, genererat från källan.