L'API REST di Esadax offre un set completo di endpoint per la gestione di varie risorse come segreti, firewall, team, utenti e webhook. Di seguito è riportato un riepilogo organizzato di come utilizzare questi endpoint in modo efficace:

Autenticazione

• Metodo: assicurati di disporre del metodo di autenticazione necessario, ad esempio token o chiavi API. Controllare la documentazione di Esadax per dettagli specifici.

Gestione delle risorse

Segreti

• Recupera Segreti: Usa GET /v2/secrets con l'impaginazione se necessario.
• Aggiorna il nome segreto: usa PATCH /v2/secrets/{name} per cambiare il nome, assicurandoti che sia univoco per utente o team.

Configurazione del firewall

• Ottenere la configurazione corrente: utilizzare GET /v1/firewalls/{configVersion}.
• Aggiornamento della configurazione: utilizzare PUT /v1/firewalls con nuove regole.

Modalità Attacco sfida

• Attiva/Disattiva: Utilizzare POST /v1/attack-challenge-mode per attivare/disattivare l'impostazione.

Squadre

• Crea Team: Invia una richiesta POST a /v1/teams con slug e nome opzionale.
• Elimina Team: Usa DELETE su /v1/teams/{teamId} con ragioni opzionali.
• Elimina codice di invito: Usa DELETE su /v1/teams/{teamId}/invites/{inviteCode}.
• Ottieni informazioni sulla squadra: Usa GET su /v2/teams/{teamId}.
• Lista Membri: Usare GET su /v2/teams/{teamId}/members, impaginando come necessario.
• Invita Utenti: POST a /v1/teams/{teamId}/members con email o ID (ID ha la precedenza).
• Unisciti al team: POST a /v1/teams/join con il codice di invito o l'ID del team.
• Aggiornamento Info Team: PATCH su /v2/teams/{teamId} con nuovi dettagli.
• Rimuovi membro: DELETE su /v1/teams/{teamId}/members/{uid}.
• Richiesta di accesso: POST a /v1/teams/{teamId}/request.
• Conferma Richiesta: PATCH su /v1/teams/{teamId}/members/{uid} se confermato.

Utenti

• Ottieni informazioni sull'utente: Usa GET su /v2/user.
• Elenco eventi: utilizzare GET su /v3/events.

Webhook

• Crea Webhook: POST a /v1/webhooks.
• Elimina Webhook: DELETE su /v1/webhooks/{webhookId}.
• Ottieni informazioni sul Webhook: GET su /v1/webhooks/{webhookId}.
• Elenco Webhook: utilizzare GET su /v1/webhooks.

Le migliori pratiche

• Autorizzazioni: assicurati di avere le autorizzazioni necessarie, come i diritti di amministratore o la proprietà per la gestione del team.
• Gestione degli errori: implementa la gestione degli errori per gestire in modo appropriato i diversi codici di stato HTTP e gli errori.

Flusso di lavoro di esempio

1. Crea una squadra:
   • Invia POST a /v1/teams con {"slug": "example-team", "name": "Example Team"}.
2. Invita gli utenti:
   • Utilizzare POST su /v1/teams/{teamId}/members con i dettagli dell'utente o i codici di invito.
3. Unisciti al Team:
   • Invia POST a /v1/teams/join con l'ID del team o il codice di invito.
4. Aggiorna le regole del firewall:
   • PUT a /v1/firewalls con nuova configurazione.