Zum Inhalt springen
Documentation

Referenz der Service-Endpunkte

Alle Pfade auf dieser Seite beziehen sich auf:

https://api.champrep.com

Verwenden Sie eine bereichsbezogene Bearer-Anmeldeinformation, wie im Abschnitt „Authentifizierung und API-Schlüssel“ beschrieben. Authentifizierung und SchlüsselAPI. Eine aufgeführte Route unterliegt weiterhin der aktuellen Serviceverfügbarkeit, den Einstellungen für Tarife und Organisationen, den Rollenberechtigungen, dem Ressourcenzugriff sowie den Live-Nutzungskontrollen.

BereichPräfixGültigkeitsbereiche
Identität und Profil/v1/auth, /v1/usersusers:read sowie den Kontext der Anmeldedaten
Suche dienstübergreifend/v1/searchDer Lesebereich jedes durchsuchten Dienstes
Drive/v1/drivedrive:read, drive:write, drive:delete
Chat/v1/chatchat:read, chat:write
Calendar/v1/calendarcalendar:read, calendar:write
Contacts/v1/contactscontacts:read, contacts:write
Meet/v1/meetmeet:read, meet:write
Notes/v1/notesnotes:read, notes:write
Tabellen/v1/sheetssheets:read, sheets:write, sheets:share, sheets:delete, sheets:export
Dokumente/passthrough/docsdocs:read, docs:write, docs:share, docs:delete, docs:export
Learn/v1/learn, /v1/coursescourses:read, courses:write
CHAMPREP AI/v1/aiai:chat
Mail/v1/mailmail:read, mail:write, mail:send
Work/v1/workwork:read, work:write, work:delete
Org Chart/v1/chartscharts:read, charts:write, charts:delete
Forms/v1/formsforms:read, forms:write
Invoice/v1/invoiceinvoice:read, invoice:write, invoice:send, invoice:delete
CHAMPREP QA/v1/qaqa:read, qa:write
CHAMPREP Code/passthrough/codecode: Gültigkeitsbereiche, siehe CHAMPREP Code
Runner-Farm/passthrough/runner-farmrunner_farm:read, runner_farm:write
CHAMPREP Business/v1/businessbusiness:read, business:manage
Abrechnung/v1/billingbilling:read, billing:manage
Webhooks/v1/webhookswebhooks:manage

GET, HEAD, und OPTIONS erfordern in der Regel den Lesebereich. Methoden zum Erstellen, Aktualisieren und Ausführen von Aktionen erfordern den Schreib- oder Verwaltungsbereich. Löschmethoden erfordern einen Löschbereich, sofern der Dienst einen solchen definiert. Eine Route kann zusätzliche Rollen- oder Ressourcenberechtigungen im Ziel-Dienst erfordern.

MethodePfadZweck
GET/v1/versionGeben Sie Informationen zur öffentlichen Gateway-Version zurück.
GET/v1/auth/whoamiDen aktiven Benutzer, das Profil, die Anmeldedaten und den Tarifkontext zurückgeben.
GET/v1/auth/quotaDen aktuellen Snapshot des Schlüssel- und Gateway-Kontingents zurückgeben.
GET/v1/users/meDas Profil des aktuellen Benutzers zurückgeben.
GET/v1/users/me/notificationsBenachrichtigungen auflisten, die für den aktuellen Benutzer sichtbar sind.

Der browsergestützte AustauschCLI nutzt zudem /v1/auth/cli/start, /v1/auth/cli/device, und /v1/auth/cli/poll. Diese Routen werden von der offiziellen Anwendung implementiertCLI; benutzerdefinierte Anwendungen sollten das GenehmigungsprotokollCLI nicht nachahmen, wenn ein SchlüsselAPI ihren Anforderungen entspricht.

MethodePfadGültigkeitsbereichZweck
GET/v1/searchPro Dienst, siehe untenDurchsuchen Sie alle Dienste, auf die diese Anmeldedaten Zugriff haben, in einem einzigen Aufruf.
GET/v1/search/servicesKeineGeben Sie an, welche Dienste mit diesen Anmeldedaten durchsucht werden können.

/v1/search verteilt die Anfrage auf die Dienste, die die Suche unterstützen, und führt die Ergebnisse zusammen. Parameter:

ParameterStandardZweck
qerforderlichDer Suchbegriff.
limit5Maximale Ergebnisse pro Dienst, bis zu 20.
servicesalleDurch Kommas getrennte Liste, zum Beispiel mail,drive. Dies schränkt den Fan-Out ein.
semanticfalseEinstellungen true um die Ergebnisse mit KI neu zu ordnen und eine kurze Antwort zu erhalten. Verbraucht Ihre eigenen KI-Guthaben.

semantic=true fügt einen KI-Durchlauf über die bereits vorliegenden Ergebnisse hinzu: Er liest Ihre Frage, ordnet die Treffer danach neu, wie gut sie diese beantworten, fügt jedem eine kurze Begründung hinzu und liefert einen ein Absatz langen answer.

Die Kosten werden mit Ihren eigenen KI-Guthaben beglichen. – das entspricht dem gleichen monatlichen Kontingent, das der CHAMPREP AIAssistent nutzt. Es fallen keine Kosten an, solange Sie nicht danach fragen, und die Stichwortsuche kostet niemals KI-Guthaben.

Jede Antwort gibt Auskunft darüber, was in semantic:

"semantic": { "requested": true, "applied": true, "answer": "..." }

Wenn der KI-Durchlauf nicht ausgeführt werden kann, werden Ihre Suchergebnisse unverändert zurückgegeben und semantic Erklärt, warum:

reasonBedeutung
AI_CREDITS_EXHAUSTEDSie haben Ihre monatlichen KI-Guthaben aufgebraucht.
PLAN_NO_AIIhr Tarif umfasst den KI-Dienst nicht.
AI_UNAVAILABLEDer KI-Dienst war dieses Mal nicht erreichbar.

Ein fehlgeschlagener KI-Durchlauf führt niemals zu einem Fehlschlag der Suche. Rufen Sie an /v1/search/services zu prüfen, ob die Smart-Suche verfügbar ist – sie gibt semantic.available sowie Ihre verbleibenden Guthaben – und blenden Sie die KI-Option aus, wenn dies nicht der Fall ist.

Ein Dienst ist nur dann enthalten, wenn die Anmeldeinformationen über den entsprechenden Lesebereich verfügen (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) und sofern der aktive Tarif dies zulässt. Beide Prüfungen schlagen fehl, sodass ein Dienst, den Sie nicht nutzen können, niemals Ergebnisse liefert.

Chat Nachrichten werden im Ruhezustand verschlüsselt und nur innerhalb der Räume durchsucht, denen Sie angehören, wobei der aktuelle Verlauf anstelle des gesamten Archivs herangezogen wird.

Terminal-Fenster
curl -H "Authorization: Bearer $CHAMPREP_API_KEY" \
"https://api.champrep.com/v1/search?q=roadmap&services=mail,notes&limit=3"

Die Ergebnisse werden nach Diensten gruppiert und auf ein einheitliches Format normiert, sodass ein Client jeden Dienst auf dieselbe Weise darstellt:

{
"success": true,
"data": {
"query": "roadmap",
"groups": [
{
"service": "notes",
"label": "Notes",
"results": [
{ "id": "6650...", "title": "Q3 roadmap", "subtitle": "Planning notes for...", "timestamp": "2026-08-02T10:14:00Z" }
]
}
],
"totalResults": 1,
"searched": ["notes", "mail"],
"skipped": [{ "service": "drive", "reason": "INSUFFICIENT_SCOPE" }],
"cost": 2
}
}

Lesen skipped bevor Sie ein leeres Ergebnis als „Nichts gefunden“ behandeln. Jeder Eintrag erklärt, warum ein Dienst ausgelassen wurde – INSUFFICIENT_SCOPE, NOT_IN_PLAN, oder SERVICE_UNAVAILABLE wenn ein Backend zu langsam oder kurzzeitig nicht erreichbar war. Ein nicht verfügbarer Dienst führt niemals zum Scheitern der gesamten Abfrage; die übrigen Ergebnisse werden weiterhin zurückgegeben.

Eine Suche greift auf einen Dienst pro Ergebnisgruppe zu, daher wird sie auch entsprechend abgerechnet: eine Ratenbegrenzungseinheit pro tatsächlich durchsuchtem Dienst. Die cost Das Feld in jeder Antwort gibt genau an, was in Rechnung gestellt wurde, und X-RateLimit-Remaining Dies wird bereits berücksichtigt, bevor Sie die Antwort erhalten.

AnfrageDurchsuchte DiensteKosten
?q=roadmap bei einem Tarif mit allen acht88
?q=roadmap&services=mail11
?q=roadmap bei einem Tarif mit nur Notes11

Ihnen werden niemals Kosten für einen Dienst berechnet, den Sie nicht nutzen können; daher ist die Eingrenzung mit services ist der kostengünstigste Weg, um eine interaktive Suche reaktionsschnell zu halten. Wenden Sie stets ein Debounce an – senden Sie niemals eine Anfrage pro Tastenanschlag.

MethodePfadGültigkeitsbereichZweck
GET/v1/drive/filesdrive:readDateien auflisten oder suchen. Verwenden Sie die search Abfrage bei Bedarf.
GET/v1/drive/foldersdrive:readInhalt des Stammordners auflisten.
GET/v1/drive/folders/{folderId}drive:readDen Inhalt eines Ordners auflisten.
GET/v1/drive/starreddrive:readMit Stern markierte Elemente auflisten.
GET/v1/drive/recentdrive:readLetzte Elemente auflisten.
GET/v1/drive/shareddrive:readGeteilte Elemente auflisten.
GET/v1/drive/quotadrive:readAktuelle Speicherauslastung und -verfügbarkeit zurückgeben.
POST/v1/drive/uploaddrive:writeErstellen Sie ein Upload-Ziel.
POST/v1/drive/filesdrive:writeSpeichern Sie die Metadaten der Datei nach erfolgreichem Upload.
POST/v1/drive/downloaddrive:readErstellen Sie einen kurzlebigen Download-Link, der an die aufrufenden Anmeldedaten gebunden ist.
GET/v1/drive/content/{token}drive:readÜbermitteln Sie einen von /v1/drive/download.
POST/v1/drive/foldersdrive:writeErstellen Sie einen Ordner.
POST/v1/drive/renamedrive:writeEin Element verschieben oder umbenennen.
POST/v1/drive/deletedrive:deleteEin oder mehrere Elemente löschen.
DELETE/v1/drive/files/{fileId}drive:deleteLöschen Sie eine Datei über den bisherigen Einzelobjekt-Weg.

Der Download erfolgt in zwei Schritten: POST /v1/drive/download gibt einen url auf dem Gateway, der nur für den SchlüsselAPI oder die Sitzung funktioniert, die ihn angefordert hat, bis expiresInSeconds abläuft. Rufen Sie ihn mit demselben Authorization Header; der Link ist für sich allein nicht nutzbar.

Das Hochladen ist ein mehrstufiger Vorgang: Fordern Sie ein Upload-Ziel an, übertragen Sie die Bytes an dieses Ziel und speichern Sie die resultierenden Metadaten. Verwenden Sie die , wennCLI Sie diese Abfolge nicht selbst implementieren müssen.

MethodePfadGültigkeitsbereichZweck
GET/v1/chat/roomschat:readRäume auflisten, die für das aktive Profil sichtbar sind.
GET/v1/chat/rooms/{roomId}chat:readEinen Raum einsehen.
POST/v1/chat/roomschat:writeEinen Raum erstellen.
GET/v1/chat/rooms/{roomId}/messageschat:readRaumnachrichten auflisten.
POST/v1/chat/rooms/{roomId}/messageschat:writeEine Raumnachricht senden.
GET/v1/chat/messages/searchchat:readNachrichten suchen.
GET/v1/chat/unreadchat:readAnzahl ungelesener Nachrichten zurückgeben.
GET/v1/chat/favoriteschat:readFavorisierte Nachrichten auflisten.
MethodePfadGültigkeitsbereichZweck
GET/v1/calendar/eventscalendar:readTermine auflisten; unterstützt startDate und endDate Abfragen.
GET/v1/calendar/events/{eventId}calendar:readEin Ereignis abrufen.
POST/v1/calendar/eventscalendar:writeErstellen Sie eine Veranstaltung.
PATCH/v1/calendar/events/{eventId}calendar:writeEreignis aktualisieren.
DELETE/v1/calendar/events/{eventId}calendar:writeEin Ereignis löschen.
GET/v1/calendar/upcomingcalendar:readAnstehende Besprechungen auflisten.
GET/v1/calendar/invitationscalendar:readAusstehende Einladungen auflisten.

Senden Sie Zeitstempel von Terminen im ISO 8601-Format mit einer expliziten Zeitzone. Das Erstellen und Aktualisieren von Terminen beansprucht das für den aktiven Tarif und die Organisation konfigurierte Kontingent; die APIlegt kein universelles, festes Tariflimit fest.

MethodePfadGültigkeitsbereichZweck
GET/v1/contactscontacts:readKontakte auflisten.
GET/v1/contacts/searchcontacts:readKontakte mit suchen q oder email.
GET/v1/contacts/favoritescontacts:readFavoriten auflisten.
GET/v1/contacts/labelscontacts:readZeigen Sie Labels an.
GET/v1/contacts/{contactId}contacts:readEinen Kontakt abrufen.
POST/v1/contactscontacts:writeEinen Kontakt hinzufügen.
PUT/v1/contacts/{contactId}contacts:writeAktualisieren Sie die Metadaten eines Kontakts.
DELETE/v1/contacts/{contactId}contacts:writeEinen Kontakt löschen.
MethodePfadGültigkeitsbereichZweck
GET/v1/meet/roomsmeet:readBesprechungsräume auflisten.
GET/v1/meet/rooms/{roomId}meet:readEinen Raum einsehen.
POST/v1/meet/roomsmeet:writeEinen Raum erstellen.
GET/v1/meet/sessionsmeet:readBesprechungssitzungen auflisten.
GET/v1/meet/sessions/{sessionId}/participantsmeet:readListen Sie die Sitzungsteilnehmer auf.
GET/v1/meet/recordingsmeet:readVerfügbare Aufzeichnungen auflisten.
GET/v1/meet/transcriptionsmeet:readTranskriptionen auflisten.
GET/v1/meet/transcriptions/{sessionId}meet:readLesen Sie eine Transkription der abschließenden Sitzung.
GET/v1/meet/usagemeet:readDie aktuelle Nutzung von Besprechungen zurückgeben.

Der Zugriff auf Aufzeichnungen und Transkriptionen hängt von der Eigentümerschaft der Besprechung, der Einwilligung, der Aufbewahrungsfrist, dem Tarif und den Richtlinien der Organisation ab.

MethodePfadGültigkeitsbereichZweck
GET/v1/notesnotes:readNotizen auflisten.
GET/v1/notes/sharednotes:readNotizen auflisten, die für das aktive Profil freigegeben sind.
GET/v1/notes/{noteId}notes:readEine Notiz lesen.
POST/v1/notesnotes:writeEine Notiz erstellen.
PATCH/v1/notes/{noteId}notes:writeEine Notiz aktualisieren.
DELETE/v1/notes/{noteId}notes:writeEine Notiz löschen.
POST/v1/notes/{noteId}/sharenotes:writeEine Notiz unter Verwendung der unterstützten Zugriffseinstellungen freigeben.

/v1/learn und /v1/courses die gleichen kuratierten Kurspfade bereitstellen.

MethodePfadGültigkeitsbereichZweck
GET/v1/learncourses:readVerfügbare Kurse auflisten.
GET/v1/learn/enrolled/mycourses:readDie Anmeldungen des aktiven Benutzers auflisten.
GET/v1/learn/{courseId}courses:readEinen Kurs abrufen.
GET/v1/learn/{courseId}/sectionscourses:readKursabschnitte auflisten.
POST/v1/learncourses:writeEinen Kurs erstellen, sofern die Rolle dies zulässt.
PUT/v1/learn/{courseId}courses:writeEinen Kurs aktualisieren, sofern die Rolle dies zulässt.

Verwenden Sie das /v1/courses Verwenden Sie stattdessen das Präfix, wenn Sie eine Integration pflegen, die diesen Alias bereits verwendet.

MethodePfadGültigkeitsbereichZweck
POST/v1/ai/chatai:chatSenden Sie eine Eingabeaufforderung oder eine unterstützte Konversationsnachricht.
GET/v1/ai/conversationsai:chatGespeicherte Unterhaltungen auflisten.
GET/v1/ai/conversations/{conversationId}ai:chatEine Konversation abrufen.
DELETE/v1/ai/conversations/{conversationId}ai:chatEine Konversation löschen.
GET/v1/ai/usageai:chatDie aktuelle KI-Nutzung abrufen.

AI-Ausgaben können unvollständig oder fehlerhaft sein. Überprüfen Sie wichtige Ausgaben und senden Sie keine Daten, zu deren Weitergabe der aktive Benutzer nicht berechtigt ist.

MethodePfadGültigkeitsbereichZweck
GET/v1/mail/accountsmail:readListen Sie verbundene E-Mail-Konten auf.
GET/v1/mail/emailsmail:readNachrichten auflisten.
GET/v1/mail/emails/{emailId}mail:readEine Nachricht lesen.
GET/v1/mail/threadsmail:readListen Sie Threads auf.
GET/v1/mail/threads/{threadId}mail:readEinen Thread abrufen.
POST/v1/mail/sendmail:sendEine Nachricht senden.
GET/v1/mail/domainsmail:readSichtbare E-Mail-Domänen auflisten.

Die Work„Gateway“-Oberfläche spiegelt die unterstützte, versionierte unterWorkAPI /v1/work. Das Gateway ermittelt den erforderlichen Umfang anhand der HTTP-Methode:

  • Lese-Methoden erfordern work:read.
  • Die Methoden „create“ und „update“ erfordern work:write.
  • Löschmethoden sowie destruktive Massenaktionen oder Aktionen zum Abbrechen von Importen erfordern work:delete.

Zu den gängigen Routen gehören:

MethodePfadZweck
GET, POST/v1/work/boardsBoards auflisten oder erstellen.
GET, PUT, DELETE/v1/work/boards/{boardId}Ein Board lesen, aktualisieren oder archivieren.
GET/v1/work/boards/{boardId}/kanbanLesen Sie die Kanban-Ansicht des Boards.
GET/v1/work/boards/{boardId}/export/csvEin Board als CSV exportieren.
GET/v1/work/boards/{boardId}/export/jsonEinen strukturierten Board-Snapshot exportieren.
GET, POST/v1/work/ticketsTickets suchen oder erstellen.
GET, PUT, DELETE/v1/work/tickets/{ticketId}Ein Ticket lesen, aktualisieren oder archivieren.
GET/v1/work/me/dashboardRufen Sie die Zusammenfassung des aktiven „Work“-DashboardsWork ab.
GET/v1/work/me/quotaGeben Sie die aktuelle NutzungWork und die Limits zurück.
GET, POST/v1/work/import/jobsUnterstützte Importaufträge auflisten oder verwalten.

Boards, Tickets, Sprints, Automatisierungen, Importe, Zeiterfassungen, Kommentare, Anhänge, gespeicherte Ansichten und die Zugehörigkeit zu Arbeitsbereichen unterliegen auch nach der Gateway-Gültigkeitsbereichsprüfung weiterhin ihrenWork Rollen und Ressourcenberechtigungen.

Die OberflächeOrg Chart „“ ist unter /v1/charts. Lese-Methoden erfordern charts:read, Methoden zum Erstellen und Aktualisieren erfordern charts:writeDie Methoden „“, „“ und „delete“ erfordern charts:delete.

Zu den gängigen Routen gehören:

MethodePfadZweck
GET/v1/charts/me/org-chartLesen Sie das Diagramm des aktiven Benutzers.
GET/v1/charts/me/positionLesen Sie die aktuelle Chart-Position ab.
GET/v1/charts/me/connectionsLesezugriff auf Beziehungsverbindungen.
GET/v1/charts/me/suggestionsLesen Sie Vorschläge zu Beziehungen.
GET/v1/charts/users/searchSuchen Sie nach Benutzern für Diagrammbeziehungen.
GET/v1/charts/orgs/{orgId}/chartLesen Sie ein Organisationsdiagramm.
PATCH/v1/charts/orgs/{orgId}/configAktualisieren Sie die Diagrammkonfiguration.
POST/v1/charts/orgs/{orgId}/chart/nodesErstellen Sie einen Diagrammknoten.
PATCH, DELETE/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}Knoten aktualisieren oder löschen.

Das Gateway stellt außerdem die folgenden versionierten Dienstpräfixe bereit:

PräfixLesebereichSchreib- oder AktionsbereichLöschbereich
/v1/formsforms:readforms:write—
/v1/sheetssheets:read; Exportaktionen verwenden sheets:exportsheets:write; Freigabe und Veröffentlichung verwenden sheets:sharesheets:delete
/v1/invoiceinvoice:readinvoice:write; zum Senden oder Auslösen von Aktionen verwenden invoice:sendinvoice:delete
/v1/qaqa:readqa:write—
/v1/businessbusiness:readbusiness:manage—
/v1/billingbilling:readbilling:manage—

Diese Präfixe bewahren das unterstützte Ressourcen-Suffix unterhalb des Gateways bei und zentralisieren gleichzeitig die Authentifizierung, den Dienstzugriff, die Gültigkeitsbereiche, die Ratenbegrenzungen und den Audit-Kontext. Bevorzugen Sie eine vom Dienst explizit bereitgestellte Route, anstatt Ressourcenpfade aus dem Browser-Datenverkehr zu erraten.

Die Abrechnung ist eine Schnittstelle der Steuerungsebene. Sie unterliegt weiterhin den API GatewayZugriffs-, Ratenbegrenzungs- und Abrechnungsbereichen, selbst wenn ein Ziel-Service-Gate einen Benutzer daran hindern würde, eine Zahlung zu korrigieren oder ein Upgrade durchzuführen.

CHAMPREP Code, Runner Farm und Docs werden über einen Passthrough erreicht: Das Gateway leitet Ihre Anfrage unterAPI einem festen Pfad an den eigenen REST-Endpunkt des jeweiligen Dienstes weiter, nachdem dieselben Überprüfungen hinsichtlich Schlüssel, Ratenbegrenzung, Tarif und Geltungsbereich wie bei jeder anderen Route durchgeführt wurden. Der Pfad nach dem Präfix ist der dienstinterne APIPfad.

PräfixWeiterleitungenBeispiel
/passthrough/codeCHAMPREP Code-PfadeAPI unter /v1/codeGET /passthrough/code/v1/code/projects
/passthrough/runner-farmRunner-Farm-PfadeAPI unter /v1GET /passthrough/runner-farm/v1/pools
/passthrough/docs„Docs“-PfadeAPI unter /api/v1/docsGET /passthrough/docs/api/v1/docs/documents

Ein Pfad außerhalb des zulässigen Namensraums führt zu 404 NOT_FOUND. Nur die eigenen Anmeldedaten des Gateways haben Zugriff auf den Dienst: Senden Sie keine Dienst-Token in Headern oder in job_token, private_token, oder access_token Abfrageparameter, da das Gateway diese entfernt.

  • GET, HEAD, und OPTIONS benötigen mindestens einen code: Leseberechtigung. Andere Methoden erfordern code:api oder ein code:write_ Gültigkeitsbereich.
  • CHAMPREP Code überprüft anschließend den genauen Geltungsbereich für jeden Endpunkt, genauso wie es ein persönliches Zugriffstoken überprüft. Zum Beispiel erfordert das Lesen von Repository-Dateien code:read_repository, code:read_api, oder code:api.
  • Pfade unter /v1/code/admin benötigen einen Schlüssel, der code:admin_mode nach Name sowie ein Konto, das Code-Administrator ist. Die Platzhalter „*“ und code:api erreichen diese nicht.
  • Lesezugriffe erfordern runner_farm:read. Andere Methoden erfordern runner_farm:write.
  • Ein Schlüssel hat niemals Zugriff auf Connector-Geheimnisse, Runner-Token, die Token-Prüfung, die Kopplung oder die eigenen Endpunkte des Connectors, und er kauft niemals Guthaben oder ändert Zahlungseinstellungen. Verwenden Sie hierfür die Runner-Farm-App, während Sie angemeldet sind.

AnfrageGültigkeitsbereich
GET, HEADdocs:read
Ein Pfad, der Berechtigungen, Freigabelinks oder Veröffentlichungen verwaltetdocs:share
DELETE, oder ein Pfad, der auf /purgedocs:delete
Ein Pfad, der auf /exportdocs:export
Jede andere Änderungdocs:write

Das Löschen eines Bildes innerhalb eines Dokuments ist eine gewöhnliche Bearbeitung und erfordert docs:write.

Die Webhook-Verwaltung verwendet /v1/webhooks und webhooks:manage. Weitere Informationen finden Sie im entsprechenden Webhook-Handbuch für die Endpunktregistrierung, die Überprüfung signierter Übermittlungen, den Wiederholungsschutz und die Rotation von Geheimnissen.

Halten Sie Ihre Integrationen auf dem neuesten Stand

Abschnitt betitelt „Halten Sie Ihre Integrationen auf dem neuesten Stand“
  • Verwenden Sie GET /v1/version für Informationen zur Gateway-Version.
  • Ignorieren Sie zusätzliche Antwortfelder, die Ihr Client nicht versteht.
  • Lesen Sie die Live-Limit-Header aus, anstatt Planwerte fest zu programmieren.
  • Verwenden Sie den Umfang mit den geringsten Berechtigungen.
  • Beachten Sie bei der Einführung einer neuen Route die Versionshinweise auf der Dokumentationsseite.