För att interagera med Esadax REST API effektivt, följ dessa organiserade steg:
-
Skaffa en åtkomsttoken:
- Använd OAuth 2.0 för att byta en OAuth-kod mot en åtkomsttoken.
- Skicka en POST-begäran till
/v1/authenticate med din OAuth-kod i begäran.
- Inkludera lämpliga rubriker som
Content-Type: application/json och Accept: application/json.
-
Utforska API-slutpunkter:
- Använd den erhållna Access Token som en Bearer token i efterföljande förfrågningar genom att lägga till huvudet
Authorization: Bearer {token}.
-
Hantera projekt:
- Skapa ett projekt: Skicka en POST-förfrågan till
/v9/projects med en tom kropp.
- Hämta projektdetaljer: Använd GET på
/v9/projects/{idOrName} där {idOrName} är projektets ID eller namn som erhållits från skapandesvaret.
-
Hantera domäner:
- Lista Domäner: Använd GET på
/v5/domains.
- Domänkonfiguration: Få åtkomst till specifika domänuppgifter med hjälp av slutpunkter som
/v6/domains/{domain}/config.
-
Hantera miljövariabler:
- Skapa projektspecifika variabler: POST till
/v9/projects/{idOrName}/env med ett JSON-objekt som innehåller variabelnamn och värde.
- Hantera globala variabler: Använd slutpunkter under
/v9/projects/env för kontoomfattande hantering.
-
Interagera med Teams:
- Team Detaljer: GET på
/v2/teams/{teamId} för att hämta laginformation.
- Teammedlemmar: Få tillgång till medlemmar via
/v2/teams/{teamId}/members.
-
Logga avloppshantering:
- Skapa loggtömningar: POST till
/v1/integrations/log-drains med konfigurationsdetaljer.
- Lista och ta bort logg avlopp: Använd GET och DELETE förfrågningar på respektive slutpunkter.
-
Hantering av omfattning:
- Se till att din åtkomsttoken har de nödvändiga omfattningarna för varje API-åtgärd.
- För omfattningsändringar följer du bekräftelseprocessen som beskrivs i Esadax dokumentation för att tillämpa uppdateringar efter användarens samtycke.
-
Felhantering:
- Ta itu med CORS genom att hantera det på din serversida.
- Kontrollera om det finns 403-fel och se till att nödvändiga parametrar som
teamId ingår i förfrågningar.
-
Testning med verktyg:
- Använd verktyg som curl för att testa slutpunkter och förstå svarstrukturer.
- Tänk på paginering när du hämtar stora listor med data.