Dokumentation
Ein Backend, vier Wege hinein. Jeder Abschnitt dokumentiert die gleichen Anwendungsfälle, sodass ein Konzept, das Sie in der REST-API lernen, dasselbe Konzept in MCP und in der CLI ist.
Erste Schritte
Authentifizierung, Arbeitsbereiche, Projekte und Ihr erster veröffentlichter Beitrag.
Noch nicht veröffentlichtDieser Abschnitt ist für die ausgelieferte API geschrieben und wird mit dieser veröffentlicht. Wir zeigen Ihnen lieber nichts als die Dokumentation für einen Endpunkt, der sich ändern könnte.
REST-API
Ressourcen, Paginierung, Idempotenz, Fehlercodes und Ratenbeschränkungen.
Noch nicht veröffentlichtDieser Abschnitt ist für die ausgelieferte API geschrieben und wird mit dieser veröffentlicht. Wir zeigen Ihnen lieber nichts als die Dokumentation für einen Endpunkt, der sich ändern könnte.
MCP-Server
Transport, OAuth, Toolkatalog, Bereiche und der Genehmigungs-Handshake.
Noch nicht veröffentlichtDieser Abschnitt ist für die ausgelieferte API geschrieben und wird mit dieser veröffentlicht. Wir zeigen Ihnen lieber nichts als die Dokumentation für einen Endpunkt, der sich ändern könnte.
CLI
Installieren, authentifizieren und den maschinenlesbaren Ausgabevertrag.
Noch nicht veröffentlichtDieser Abschnitt ist für die ausgelieferte API geschrieben und wird mit dieser veröffentlicht. Wir zeigen Ihnen lieber nichts als die Dokumentation für einen Endpunkt, der sich ändern könnte.
Webhooks
Ereigniskatalog, Signaturüberprüfung, Wiederholungsversuche und erneute Zustellung.
Noch nicht veröffentlichtDieser Abschnitt ist für die ausgelieferte API geschrieben und wird mit dieser veröffentlicht. Wir zeigen Ihnen lieber nichts als die Dokumentation für einen Endpunkt, der sich ändern könnte.
Je nach Plattformanforderungen, Kontotypen, Limits und bekannten Einschränkungen.
Fehlerreferenz
Jeder Fehlercode, was ihn verursacht und was man dagegen tun kann.
Noch nicht veröffentlichtDieser Abschnitt ist für die ausgelieferte API geschrieben und wird mit dieser veröffentlicht. Wir zeigen Ihnen lieber nichts als die Dokumentation für einen Endpunkt, der sich ändern könnte.
Worauf Sie sich verlassen können
- Jeder Schreibvorgang benötigt einen Idempotenzschlüssel. Das erneute Abspielen einer Anfrage mit demselben Schlüssel gibt das ursprüngliche Ergebnis zurück, anstatt einen zweiten Beitrag zu erstellen.
- Jeder Fehler enthält einen stabilen Code, einen Nachrichtenschlüssel und bereinigte Details. Codes ändern ihre Bedeutung zwischen den Versionen nicht.
- Wichtige Änderungen erhalten eine neue Version und ein angekündigtes Einstellungsfenster. Additive Änderungen nicht.
- Lesen, Verfassen, Einholen von Genehmigungen, Terminplanung und Veröffentlichung sind separate Bereiche. Ein Berechtigungsnachweis erhält den kleinsten Satz, der seine Aufgabe erfüllt.