Startseite/Artikel
Esadax JournalPlatform

Leitfaden für Esadax API-Integrationen

Um effektiv mit der Esadax REST API zu interagieren, folgen Sie diesen organisierten Schritten: 1. Erhalten Sie ein Zugangstoken: * Verwenden Sie OAuth 2.0, um einen OAuth-Code gegen ein Zugriffstoken auszutauschen.

Um effektiv mit der Esadax REST API zu interagieren, folgen Sie diesen organisierten Schritten:

  1. Erhalten Sie ein Zugangstoken:
    • Verwenden Sie OAuth 2.0, um einen OAuth-Code gegen ein Zugriffstoken auszutauschen.
    • Senden Sie eine POST-Anfrage an /v1/authenticate mit Ihrem OAuth-Code im Anfragetext.
    • Fügen Sie entsprechende Kopfzeilen wie Content-Type: application/json und Accept: application/json ein.
  2. API-Endpunkte erkunden:
    • Verwenden Sie das erhaltene Access Token als Bearer Token in nachfolgenden Anfragen, indem Sie den Header Authorization: Bearer {token} hinzufügen.
  3. Projekte verwalten:
    • Erstellen Sie ein Projekt: Senden Sie eine POST-Anfrage an /v9/projects mit einem leeren Körper.
    • Projektdetails abrufen: Verwenden Sie GET auf /v9/projects/{idOrName}, wobei {idOrName} die ID oder der Name des Projekts ist, der aus der Erstellungsantwort abgerufen wird.
  4. Domains verwalten:
    • Domains auflisten: Verwenden Sie GET auf /v5/domains.
    • Domänenkonfiguration: Greifen Sie mithilfe von Endpunkten wie /v6/domains/{domain}/config auf bestimmte Domänendetails zu.
  5. Umgebungsvariablen handhaben:
    • Projektspezifische Variablen erstellen: POST an /v9/projects/{idOrName}/env mit einem JSON-Objekt, das den Variablennamen und -wert enthält.
    • Globale Variablen verwalten: Verwenden Sie Endpunkte unter /v9/projects/env für die kontoweite Verwaltung.
  6. Interagieren Sie mit Teams:
    • Teamdetails: GET auf /v2/teams/{teamId}, um Teaminformationen abzurufen.
    • Teammitglieder: Greifen Sie über /v2/teams/{teamId}/members auf Mitglieder zu.
  7. Verwaltung des Protokollabflusses:
    • Log Drains erstellen: POST an /v1/integrations/log-drains mit Konfigurationsdetails.
    • Log Drains auflisten und löschen: Verwenden Sie GET- und DELETE-Anfragen auf den jeweiligen Endpunkten.
  8. Scope Management:
    • Stellen Sie sicher, dass Ihr Access Token über die erforderlichen Bereiche für jede API-Aktion verfügt.
    • Befolgen Sie bei Umfangsänderungen den Bestätigungsprozess, der in der Dokumentation von Esadax beschrieben ist, um Updates nach Zustimmung des Benutzers anzuwenden.
  9. Fehlerbehandlung:
    • Adressieren Sie CORS, indem Sie es auf Ihrer Serverseite handhaben.
    • Prüfen Sie auf 403-Fehler und stellen Sie sicher, dass erforderliche Parameter wie teamId in Anforderungen enthalten sind.
  10. Testen mit Tools:
    • Verwenden Sie Tools wie curl, um Endpunkte zu testen und Antwortstrukturen zu verstehen.
    • Achten Sie beim Abrufen großer Datenlisten auf die Paginierung.
Abonnieren