# API

Die Regeln, die auf jeder Route gelten — Adresse, Anmeldung, Fehler, Sperren, Blättern, Stabilität — und der Wegweiser durch die Referenz.

> **Typ:** bereich
> **Für wen:** Wer Aufrufe gegen /v1 baut, eine Fehlerantwort einordnen muss oder sich in der Referenz orientieren will.

![Der Portal-Dialog „API-Schlüssel erstellen“ mit ausgefülltem Namensfeld, den sechs Rechte-Klassen — gewählt ist „Nur Lesen“ mit 12 Rechten — und den Auswahlfeldern für die Gültigkeit des neuen und des alten Schlüssels](/de/api/bilder/c7e9229d-overview.png)

*Die Regeln dieses Bereichs gelten für Aufrufe mit einem Schlüssel `ak_…`; ausgestellt, rotiert und widerrufen werden die Schlüssel im Portal unter Einstellungen › API-Schlüssel.*

## Grundlagen

| Seite | Wann Sie es brauchen |
|---|---|
| [Basis-URL, /v1 und Stabilität](/de/api/base-url-and-stability) | Woher die Basis-Adresse kommt, warum fast jede Route /v1 trägt, welche Pfade außerhalb liegen und was x-stability je Operation zusagt. |
| [Anmeldung: Schlüssel und Sitzungen](/de/api/authentication) | Bearer-Kopfzeile, Schlüssel-Präfixe, Rechteumfang, Ablauf und Rotation eines Schlüssels — und wann eine Sitzung statt eines Schlüssels sinnvoll ist. |
| [Das Fehlerformat](/de/api/error-format) | Der Fehlerrumpf mit code, message und traceId, die RFC-9457-Form und die Regel, nach der aus einem Code der HTTP-Status wird. |
| [Gleichzeitige Änderungen: ETag und If-Match](/de/api/etag-and-if-match) | Eine versionierte Ressource lesen, die Version als If-Match zurückschicken und einen 409-Konflikt sauber auflösen. |
| [Drosselung und Rate-Limit-Kopfzeilen](/de/api/rate-limits) | Welche Routen eine eigene Grenze haben, welches Kontingent an einem Schlüssel hängt, was die vier Kopfzeilen bedeuten und wie ein Client auf 429 reagiert. |
| [Blättern: limit, cursor, items, nextCursor](/de/api/pagination) | Cursor-Blättern auf allen Listen, die Grenzen 50/200 und 25/100, die vier Routen mit page — und wie die CLI mit --all allen Seiten folgt. |

## Zugänge und Gegenstände

| Seite | Wann Sie es brauchen |
|---|---|
| [Delegierter Zugang mit OAuth 2.1](/de/api/oauth-delegated-access) | Ihre Anwendung läuft bei fremden Kunden: registrieren, mit PKCE einwilligen lassen, Token oat_ tauschen, erneuern, widerrufen. |
| [Provisionierung mit SCIM 2.0](/de/api/scim-provisioning) | Ein Verzeichnisdienst soll Konten anlegen, sperren und Rollen setzen: Zugang sct_, Endpunkte unter /scim/v2, Abbildung und Fehler. |
| [Der MCP-Dienst für KI-Assistenten](/de/api/mcp-service) | Ein Assistent soll mit Ihrem Bestand arbeiten: Adresse, Anmeldung, Werkzeugliste, Bestätigungspflicht, Grenzen und Fehler. |
| [Standorte](/de/api/locations) | Eine Filialstruktur spiegeln: Felder eines Standorts, seine Routen, die Zuordnung eines Displays und die Auswertung nach Orten. |
| [Web-Displays](/de/api/web-displays) | Ein Display anlegen, hinter dem kein Gerät steht: Routen, Anschluss-Adresse, die beiden Zustände, Löschen und die Grenzen gegenüber einem Gerät. |

## Fehlercodes

| Seite | Wann Sie es brauchen |
|---|---|
| [Fehlercodes: auf jeder Route möglich](/de/api/error-codes-general) | Die plattformweiten Codes für Anmeldung, Rechte, Validierung, Konflikte, Sperren, Nutzlast, HTTP, Ereignisse, Zwischenspeicher, Jobs und Ressourcen. |
| [Fehlercodes: Konten und Sitzungen](/de/api/error-codes-accounts) | Die Codes der Bereiche Identity und Sessions: Benutzerkonten, Schlüssel, Einladungen, Anmeldung, zweiter Faktor, Sitzungen. |
| [Fehlercodes: Organisation, Zugang, Beitritt](/de/api/error-codes-organization) | Die Codes der Bereiche Tenancy, Access, Onboarding und Cloud-Connections: Stammdaten, Domain, Rollen, Erteilungen, Registrierung, Speicher-Verbindungen. |
| [Fehlercodes: Abrechnung](/de/api/error-codes-billing) | Die Codes des Bereichs Billing: Paket, Lizenzen, Zubuchungen, Zahlungsmittel, Rechnungen — und warum hier 402 steht. |
| [Fehlercodes: Medien, Szenen, Programme, Apps](/de/api/error-codes-content) | Die Codes der Bereiche Media-Library, Composition, Scheduling, App-Catalog, Marketplace, App-Runtime und Advertising. |
| [Fehlercodes: Geräte, Wiedergabe, Meldungen, Betrieb](/de/api/error-codes-devices-operations) | Die Codes der Bereiche Fleet, Playback, Realtime, Notifications, Analytics, Audit und Ops-Console — letztere nur auf Betreiberrouten. |
| [Fehlercodes: Serverfehler (5xx)](/de/api/error-codes-server) | Die 119 Codes, auf die ein Client nicht fachlich reagieren kann: Invarianten, Start, Datenbank, nachgelagerte Dienste — wiederholen oder melden. |

## Referenz-Wegweiser

| Seite | Wann Sie es brauchen |
|---|---|
| [Die Referenz lesen](/de/api/read-reference) | Unter /api/reference eine Operation finden, Berechtigung, Sicherheitsverfahren, Beispiel und Stabilität ablesen und die Spezifikation herunterladen. |
| [Die Bereiche der Referenz](/de/api/reference-areas) | Die 19 Tags der Spezifikation in ihren 7 Gruppen mit je einem Satz Zweck — und warum die Betreiber-Fläche nicht dazugehört. |
| [Einen eigenen Client aus der Spezifikation erzeugen](/de/api/generate-client) | Es gibt heute keinen veröffentlichten Client: So erzeugen Sie aus openapi.json Ihren eigenen und bilden die Konventionen der API darin ab. |