Startpagina/Artikel
Esadax JournalPlatform

Esadax API Integraties Gids

Om effectief te communiceren met de Esadax REST API, volgt u deze georganiseerde stappen: 1. Een toegangstoken verkrijgen: * Gebruik OAuth 2.0 om een OAuth-code uit te wisselen voor een Access

Om effectief te communiceren met de Esadax REST API, volgt u deze georganiseerde stappen:

  1. Een toegangstoken verkrijgen:
    • Gebruik OAuth 2.0 om een OAuth-code uit te wisselen voor een Access Token.
    • Stuur een POST-verzoek naar /v1/authenticate met uw OAuth-code in de hoofdtekst van het verzoek.
    • Voeg de juiste headers toe, zoals Content-Type: application/json en Accept: application/json.
  2. Verken API-eindpunten:
    • Gebruik het verkregen Access Token als een Bearer token in volgende verzoeken door de header Authorization: Bearer {token} toe te voegen.
  3. Projecten beheren:
    • Maak een project aan: Stuur een POST-verzoek naar /v9/projects met 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.
  4. Domeinen beheren:
    • Lijst Domeinen: Gebruik GET op /v5/domains.
    • Domeinconfiguratie: Toegang tot specifieke domeindetails met behulp van eindpunten zoals /v6/domains/{domain}/config.
  5. Behandel omgevingsvariabelen:
    • Projectspecifieke variabelen maken: POST naar /v9/projects/{idOrName}/env met een JSON-object dat de variabelenaam en -waarde bevat.
    • Algemene variabelen beheren: Gebruik eindpunten onder /v9/projects/env voor accountbreed beheer.
  6. 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.
  7. Log afvoerbeheer:
    • Create Log Drains: POST naar /v1/integrations/log-drains met configuratie details.
    • Logdrains weergeven en verwijderen: Gebruik GET- en DELETE-verzoeken op de respectieve eindpunten.
  8. 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.
  9. Afhandeling van fouten:
    • Pak CORS aan door het op je server te verwerken.
    • Controleer op 403-fouten en zorg ervoor dat vereiste parameters zoals teamId zijn opgenomen in verzoeken.
  10. 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.
Abonneren