Einstieg

Schnellstart

Lesedauer · 8 Min.Aktualisiert · 2026-05-01

Diese Seite zeigt Ihnen den kürzesten Pfad zum ersten erfolgreichen Request. Sie brauchen nur curl und einen Account mit Zugriff auf einen Mandanten.

Voraussetzungen

Ein aktiver Codemeta-OS-Account.
Der Mandant, in dem Sie arbeiten möchten, ist Ihrem Account zugeordnet.
Aktivierte Zwei-Faktor-Authentifizierung (plattformweit verpflichtend).

Schritte

Anmelden und Session-Cookie speichern. Codemeta OS nutzt opake Sessions (kein JWT). Die Session wird als HTTP-Only-Cookie ausgegeben und bei jedem Request mitgeschickt.
```
curl -X POST https://os.codemeta.de/api/auth/sign-in/email \
  -H "Content-Type: application/json" \
  -c cookies.txt \
  -d '{"email":"alice@example.com","password":"…"}'
```
Bei erfolgreichem Sign-in steckt das Session-Cookie in cookies.txt. Bewahren Sie diese Datei für die nächsten Requests auf.
Mandantenkontext setzen. Jeder Aufruf an die Tenant-API (/api/v1/...) braucht den Header X-Tenant-Id mit der UUID des Mandanten, in dessen Daten Sie arbeiten.
```
export TENANT="0192f2c0-8d1c-7a3b-9e4f-d3e7f1a2b5c8"
```
Ersten Lese-Request absetzen. Listen-Endpoints liefern paginierte Ergebnisse. limit, offset und cursor sind als Query-Parameter steuerbar.
```
curl https://os.codemeta.de/api/v1/tickets?limit=10 \
  -H "X-Tenant-Id: $TENANT" \
  -b cookies.txt
```

Eine Entity anlegen. POST-Requests sind über den X-Idempotency-Key-Header idempotent: Wiederholte Requests mit derselben Key-Body-Kombination liefern dieselbe Antwort, ohne eine neue Entity zu erzeugen.

curl -X POST https://os.codemeta.de/api/v1/tickets \
  -H "X-Tenant-Id: $TENANT" \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: 6b6e9b37-8a72-4d5b-8b2c-9a3d2c1e5f64" \
  -b cookies.txt \
  -d '{"title":"Drucker hängt","priority":"normal"}'

Antwortformat

Erfolgreiche Antworten sind JSON. Listen liegen in data, die Blätter-Information in meta — siehe Pagination. Einzelne Entities werden direkt als Objekt zurückgegeben.

Fehler folgen RFC 7807. Mehr dazu unter Plattform-Garantien.

Was als Nächstes?

Multi-Tenancy verstehen – warum es den Header X-Tenant-Id gibt und was passiert, wenn Sie ihn vergessen.
Berechtigungen & Scopes – das zwei-stufige Modell aus funktionalen Permissions und Datenscopes.
Audit-Historie – jede Änderung als JSON-Patch.
API-Referenz – alle Endpoints mit Schema und Beispielen.