Guida alle integrazioni Esadax API

Autore:Esadax
Aggiornato:13 ago 2025

Per interagire con l'API REST di Esadax in modo efficace, segui questi passaggi organizzati:

  1. Ottieni un token di accesso:

    • Usa OAuth 2.0 per scambiare un codice OAuth con un token di accesso.
    • Invia una richiesta POST a /v1/authenticate con il tuo codice OAuth nel corpo della richiesta.
    • Includere intestazioni appropriate come Content-Type: application/json e Accept: application/json.
  2. Esplora gli endpoint API:

    • Utilizzare il Token di accesso ottenuto come token Bearer nelle richieste successive aggiungendo l'intestazione Authorization: Bearer {token}.
  3. Gestire i progetti:

    • Crea un progetto: Invia una richiesta POST a /v9/projects con un corpo vuoto.
    • Recupera i dettagli del progetto: Usa GET su /v9/projects/{idOrName} dove {idOrName} è l'ID o il nome del progetto ottenuto dalla risposta di creazione.
  4. Gestire i domini:

    • Elenco domini: Utilizzare GET su /v5/domains.
    • Configurazione del dominio: Accedi a dettagli specifici del dominio utilizzando endpoint come /v6/domains/{domain}/config.
  5. Maniglia variabili ambientali:

    • Crea variabili specifiche del progetto: POST a /v9/projects/{idOrName}/env con un oggetto JSON contenente il nome e il valore della variabile.
    • Gestisci variabili globali: Utilizza gli endpoint sotto /v9/projects/env per la gestione a livello di account.
  6. Interagisci con le squadre:

    • Dettagli della squadra: GET su /v2/teams/{teamId} per recuperare le informazioni sulla squadra.
    • Membri del team: Accedi ai membri tramite /v2/teams/{teamId}/members.
  7. Gestione del drenaggio del registro:

    • Crea drenaggi di registro: POST a /v1/integrations/log-drains con i dettagli di configurazione.
    • Elenco ed eliminazione dei drenaggi di log: Utilizzare le richieste GET e DELETE sui rispettivi endpoint.
  8. Gestione dell'ambito:

    • Assicurati che il tuo token di accesso abbia gli ambiti necessari per ogni azione API.
    • Per le modifiche dell'ambito, seguire il processo di conferma descritto nella documentazione di Esadax per applicare gli aggiornamenti dopo il consenso dell'utente.
  9. Gestione degli errori:

    • Affronta CORS gestendolo sul lato server.
    • Verificare la presenza di errori 403 e assicurarsi che i parametri obbligatori come teamId siano inclusi nelle richieste.
  10. Test con Strumenti:

    • Utilizza strumenti come curl per testare gli endpoint e comprendere le strutture di risposta.
    • Prestare attenzione all'impaginazione quando si recuperano grandi elenchi di dati.