Om effectief te communiceren met de Esadax REST API, volgt u deze georganiseerde stappen:
- Een toegangstoken verkrijgen:
- Gebruik OAuth 2.0 om een OAuth-code uit te wisselen voor een Access Token.
- Stuur een POST-verzoek naar
/v1/authenticatemet uw OAuth-code in de hoofdtekst van het verzoek. - Voeg de juiste headers toe, zoals
Content-Type: application/jsonenAccept: application/json.
- Verken API-eindpunten:
- Gebruik het verkregen Access Token als een Bearer token in volgende verzoeken door de header
Authorization: Bearer {token}toe te voegen.
- Gebruik het verkregen Access Token als een Bearer token in volgende verzoeken door de header
- Projecten beheren:
- Maak een project aan: Stuur een POST-verzoek naar
/v9/projectsmet een lege body. - Projectgegevens ophalen: Gebruik GET op
/v9/projects/{idOrName}waarbij{idOrName}de ID of naam van het project is die is verkregen uit de aanmaakreactie.
- Maak een project aan: Stuur een POST-verzoek naar
- Domeinen beheren:
- Lijst Domeinen: Gebruik GET op
/v5/domains. - Domeinconfiguratie: Toegang tot specifieke domeindetails met behulp van eindpunten zoals
/v6/domains/{domain}/config.
- Lijst Domeinen: Gebruik GET op
- Behandel omgevingsvariabelen:
- Projectspecifieke variabelen maken: POST naar
/v9/projects/{idOrName}/envmet een JSON-object dat de variabelenaam en -waarde bevat. - Algemene variabelen beheren: Gebruik eindpunten onder
/v9/projects/envvoor accountbreed beheer.
- Projectspecifieke variabelen maken: POST naar
- Interactie met teams:
- Team Details: GET op
/v2/teams/{teamId}om team informatie op te halen. - Teamleden: Toegang tot leden via
/v2/teams/{teamId}/members.
- Team Details: GET op
- Log afvoerbeheer:
- Create Log Drains: POST naar
/v1/integrations/log-drainsmet configuratie details. - Logdrains weergeven en verwijderen: Gebruik GET- en DELETE-verzoeken op de respectieve eindpunten.
- Create Log Drains: POST naar
- Scope beheer:
- Zorg ervoor dat uw Access Token de nodige scopes heeft voor elke API-actie.
- Voor scope-wijzigingen volgt u het bevestigingsproces dat wordt beschreven in de documentatie van Esadax om updates toe te passen na toestemming van de gebruiker.
- Afhandeling van fouten:
- Pak CORS aan door het op je server te verwerken.
- Controleer op 403-fouten en zorg ervoor dat vereiste parameters zoals
teamIdzijn opgenomen in verzoeken.
- Testen met hulpmiddelen:
- Gebruik tools zoals curl om eindpunten te testen en responsstructuren te begrijpen.
- Houd rekening met paginatie bij het ophalen van grote lijsten met gegevens.
