Um effektiv mit der Esadax REST API zu interagieren, folgen Sie diesen organisierten Schritten:
- Erhalten Sie ein Zugangstoken:
- Verwenden Sie OAuth 2.0, um einen OAuth-Code gegen ein Zugriffstoken auszutauschen.
- Senden Sie eine POST-Anfrage an
/v1/authenticatemit Ihrem OAuth-Code im Anfragetext. - Fügen Sie entsprechende Kopfzeilen wie
Content-Type: application/jsonundAccept: application/jsonein.
- API-Endpunkte erkunden:
- Verwenden Sie das erhaltene Access Token als Bearer Token in nachfolgenden Anfragen, indem Sie den Header
Authorization: Bearer {token}hinzufügen.
- Verwenden Sie das erhaltene Access Token als Bearer Token in nachfolgenden Anfragen, indem Sie den Header
- Projekte verwalten:
- Erstellen Sie ein Projekt: Senden Sie eine POST-Anfrage an
/v9/projectsmit 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.
- Erstellen Sie ein Projekt: Senden Sie eine POST-Anfrage an
- Domains verwalten:
- Domains auflisten: Verwenden Sie GET auf
/v5/domains. - Domänenkonfiguration: Greifen Sie mithilfe von Endpunkten wie
/v6/domains/{domain}/configauf bestimmte Domänendetails zu.
- Domains auflisten: Verwenden Sie GET auf
- Umgebungsvariablen handhaben:
- Projektspezifische Variablen erstellen: POST an
/v9/projects/{idOrName}/envmit einem JSON-Objekt, das den Variablennamen und -wert enthält. - Globale Variablen verwalten: Verwenden Sie Endpunkte unter
/v9/projects/envfür die kontoweite Verwaltung.
- Projektspezifische Variablen erstellen: POST an
- Interagieren Sie mit Teams:
- Teamdetails: GET auf
/v2/teams/{teamId}, um Teaminformationen abzurufen. - Teammitglieder: Greifen Sie über
/v2/teams/{teamId}/membersauf Mitglieder zu.
- Teamdetails: GET auf
- Verwaltung des Protokollabflusses:
- Log Drains erstellen: POST an
/v1/integrations/log-drainsmit Konfigurationsdetails. - Log Drains auflisten und löschen: Verwenden Sie GET- und DELETE-Anfragen auf den jeweiligen Endpunkten.
- Log Drains erstellen: POST an
- 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.
- 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
teamIdin Anforderungen enthalten sind.
- 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.
