Per interagire con l'API REST di Esadax in modo efficace, segui questi passaggi organizzati:
- 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/authenticatecon il tuo codice OAuth nel corpo della richiesta. - Includere intestazioni appropriate come
Content-Type: application/jsoneAccept: application/json.
- Esplora gli endpoint API:
- Utilizzare il Token di accesso ottenuto come token Bearer nelle richieste successive aggiungendo l'intestazione
Authorization: Bearer {token}.
- Utilizzare il Token di accesso ottenuto come token Bearer nelle richieste successive aggiungendo l'intestazione
- Gestire i progetti:
- Crea un progetto: Invia una richiesta POST a
/v9/projectscon 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.
- Crea un progetto: Invia una richiesta POST a
- 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.
- Elenco domini: Utilizzare GET su
- Maniglia variabili ambientali:
- Crea variabili specifiche del progetto: POST a
/v9/projects/{idOrName}/envcon un oggetto JSON contenente il nome e il valore della variabile. - Gestisci variabili globali: Utilizza gli endpoint sotto
/v9/projects/envper la gestione a livello di account.
- Crea variabili specifiche del progetto: POST a
- 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.
- Dettagli della squadra: GET su
- Gestione del drenaggio del registro:
- Crea drenaggi di registro: POST a
/v1/integrations/log-drainscon i dettagli di configurazione. - Elenco ed eliminazione dei drenaggi di log: Utilizzare le richieste GET e DELETE sui rispettivi endpoint.
- Crea drenaggi di registro: POST a
- 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.
- Gestione degli errori:
- Affronta CORS gestendolo sul lato server.
- Verificare la presenza di errori 403 e assicurarsi che i parametri obbligatori come
teamIdsiano inclusi nelle richieste.
- 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.
