Etusivu/Artikkeli
Esadax JournalPlatform

Esadax API -integraatioiden opas

Jotta voit olla vuorovaikutuksessa Esadax REST API: n kanssa tehokkaasti, noudata näitä järjestettyjä vaiheita: 1. Hanki pääsytunnus: * Käytä OAuth 2.0:aa vaihtaaksesi OAuth-koodin Access Tokeniin. * Lähetä POST-pyyntö osoitteeseen /v1/

Jotta voit olla vuorovaikutuksessa Esadax REST API: n kanssa tehokkaasti, noudata näitä järjestettyjä vaiheita:

  1. Hanki pääsytunnus:
    • Käytä OAuth 2.0:aa vaihtaaksesi OAuth-koodin Access Tokeniin.
    • Lähetä POST-pyyntö osoitteeseen /v1/authenticate siten, että OAuth-koodisi on pyynnön rungossa.
    • Sisällytä sopivat otsikot, kuten Content-Type: application/json ja Accept: application/json.
  2. Tutustu API päätepisteet:
    • Käytä saatua Access Tokenia Bearer tokenina seuraavissa pyynnöissä lisäämällä otsikoksi Authorization: Bearer {token}.
  3. Hallitse hankkeita:
    • Luo projekti: Lähetä POST-pyyntö osoitteeseen /v9/projects tyhjällä rungolla.
    • Hae projektin tiedot: Käytä GET-toimintoa kohteessa /v9/projects/{idOrName}, jossa {idOrName} on projektin tunnus tai nimi, joka saadaan luontivastauksesta.
  4. Hallitse verkkotunnuksia:
    • Listaa verkkotunnukset: Käytä GET /v5/domains.
    • Verkkotunnuksen kokoonpano: Käytä tiettyjä verkkotunnuksen tietoja käyttämällä päätepisteitä, kuten /v6/domains/{domain}/config.
  5. Käsittele ympäristömuuttujat:
    • Luo projektikohtaisia muuttujia: POST /v9/projects/{idOrName}/env:een JSON-objektilla, joka sisältää muuttujan nimen ja arvon.
    • Yleisten muuttujien hallinta: Käytä /v9/projects/env-kohdan päätepisteitä tilin laajuiseen hallintaan.
  6. Vuorovaikutuksessa Teams:
    • Joukkueen tiedot: GET on /v2/teams/{teamId} hakea joukkueen tiedot.
    • Tiimin jäsenet: Pääsy jäseniin /v2/teams/{teamId}/members:n kautta.
  7. Loki tyhjennys hallinta:
    • Create Log Drains: Lähetä POST-viesti /v1/integrations/log-drains-osoitteeseen määritystiedoilla.
    • Luettele ja poista lokiviemäreitä: Käytä GET- ja DELETE-pyyntöjä vastaavissa päätepisteissä.
  8. Laajuus hallinta:
    • Varmista, että Access Tokenillasi on tarvittavat alueet jokaiselle API-toiminnolle.
    • Laajuusmuutosten osalta noudata Esadaxin dokumentaatiossa kuvattua vahvistusprosessia, jotta päivitykset voidaan ottaa käyttöön käyttäjän suostumuksen jälkeen.
  9. Virheen käsittely:
    • Käsittele CORS käsittelemällä sitä palvelimesi puolella.
    • Tarkista 403-virheet ja varmista, että vaaditut parametrit, kuten teamId, sisältyvät pyyntöihin.
  10. Testaus työkaluilla:
    • Käytä curlin kaltaisia ​​työkaluja päätepisteen testaamiseen ja vastausrakenteiden ymmärtämiseen.
    • Huomioi sivuutus, kun haet suuria tietoluetteloita.
Tilaa