API-Referenz

Die vollständige API-Referenz wird automatisch aus unserer OpenAPI-3.1-Spec generiert, sobald die Surface stabil ist. Lieber ein Platzhalter als Fake-Doku zu Endpunkten, die sich noch ändern könnten. In der Zwischenzeit hier die Form, was abgedeckt wird, und was du heute tun kannst.

Form (kann sich ändern)

REST über HTTPS. JSON rein, JSON raus. Bearer-Token-Auth bei jedem Request. Im Pfad versioniert: /v1/.... Pro Token rate-limited; die Antwort trägt die üblichen X-RateLimit-*-Header.

curl

1# jeder Endpunkt nimmt einen API-Key im Authorization-Header2curl https://api.verbumia.ca/v1/projects \3  -H "Authorization: ApiKey vrb_live_<prefix>.<secret>" 5{ "data": [{ "id": "proj_xxx", "name": "Checkout", … }] }

API-Keys kommen aus Org Settings → API Keys im Dashboard. Derselbe Key funktioniert für die CLI, den MCP-Server und direkte REST-Calls — die API konsumiert einfach den Bearer.

Ressourcen zum Launch

Diese Ressourcen wird die V1-API exponieren. Die exakte Form — Felder, Error-Codes, Pagination — landet, wenn wir die OpenAPI-Spec veröffentlichen.

Ressource	Was sie repräsentiert	V1-Ops
Projects	Workspaces. Anlegen, listen, archivieren, Ownership übertragen.	GET · POST · PATCH · DELETE
Locales	Projekt-scoped Locale-Set. Locale hinzufügen, als Default markieren, für Clients aktivieren/deaktivieren.	GET · POST · PATCH · DELETE
Namespaces	Logische Buckets von Keys pro Projekt (z. B. "checkout", "common").	GET · POST · PATCH · DELETE
Keys	Übersetzungs-Keys mit Beschreibung, Screenshot-URLs, Max-Length, Plural-Regeln.	GET · POST · PATCH · DELETE
Translations	Wert eines Keys pro Locale. Draft-, In-Review-, Approved-States; Revisionshistorie.	GET · POST · PATCH · DELETE
Missing keys	Die Runtime-SDK-Queue. Listen, nach Frequenz gruppieren, als triagiert markieren.	GET · PATCH
Webhooks	Auf Übersetzungs-Events abonnieren. V2.	V2

Was du heute tun kannst

Fast alles, wofür du zur API greifen würdest, ist bereits über die CLI, den MCP-Server oder das Runtime-SDK verfügbar. Nutze sie — wenn die API kommt, kann dein Code auf direkte HTTP-Calls umsteigen, ohne dass sich an dem, was er tut, etwas ändert.

CLI

@verbumia/cli

Push, Pull, Import, Export — deckt die meisten Automatisierungsbedürfnisse ab.

MCP

Claude Desktop einrichten

Keys lesen, Übersetzungen vorschlagen, PR-Diffs aus jedem Agent reviewen.

SDK

React + i18next

Übersetzungen lesen und fehlende Keys in deiner Runtime erfassen.

Referenz

Alle Docs

Index aller bisher veröffentlichten Inhalte.

Live-OpenAPI für Early Devs

Wenn du das Verbumia-Backend lokal laufen lässt, ist die Live-OpenAPI-3.1-Spec verfügbar unter:

lokales Backend

http://localhost:8820/openapi.json

Richte Stoplight, Swagger UI, Insomnia, Postman oder ein beliebiges OpenAPI-fähiges Tool auf diese URL. Die Form bewegt sich noch — deshalb ist diese Seite ein Platzhalter — aber das ist gerade die Source of Truth, falls du Endpunkte früh erkunden willst.

Wann landet die öffentliche Referenz?

Die öffentliche OpenAPI-Spec wird unter https://api.verbumia.ca/openapi.json ausgeliefert, sobald die V1-Surface eingefroren ist. Ab dann wechselt diese Seite vom Platzhalter zu einer voll gerenderten Referenz (Stoplight oder ein ähnlicher Viewer über der Spec) — kein Marketing, nur jeder Endpunkt, jedes Payload, jeder Error-Code, aus der Source generiert.