Developer
Come chiamare le API REST di Agora, con autenticazione, interrogazioni ed errori, e la reference generata dal codice.
Questa sezione è per chi integra Agora con altri sistemi tramite le API REST del backend.
Da dove partire
- Autenticazione: come ottenere e rinnovare il token.
- Interrogazioni: elenchi, paginazione, filtri e conteggi.
- Errori: formato delle risposte d'errore e limiti di frequenza.
- API: la reference degli endpoint, raggruppati per risorsa.
- Enum e stati: i valori ammessi dagli enum principali.
Cose da sapere subito
- Chiamate da server. Le API si chiamano da un sistema backend: il browser di un sito di terzi non può chiamarle (CORS ammette solo i siti delle organizzazioni).
- Organizzazione. Ogni richiesta che riguarda i dati di un'organizzazione porta l'header
x-organization-idcon l'identificativo dell'organizzazione. Senza l'header la risposta è400 Missing organization header. Non esistono indirizzi diversi per organizzazione. - Token. Le richieste autenticate portano
Authorization: Bearer <access_token>. - Nessun prefisso di versione. Gli endpoint sono alla radice (
/events,/users/{user}) e l'API è ancora in una versione preliminare: la reference qui sotto descrive quello che la piattaforma usa oggi, senza garanzia di stabilità.
Come leggere le tabelle
| Colonna | Significato |
|---|---|
| Metodo, Path | Metodo HTTP e percorso; i segmenti tra graffe sono parametri, per esempio {event}. |
| Descrizione | Operazione svolta, filtri (where) e opzioni di query o campi accettati nel corpo. |
| Rischio | read legge, create crea, mutate modifica, destructive elimina. |
| Senza token | sì se l'endpoint non richiede il token (può richiedere l'header organizzazione). |
Questo articolo ti è stato utile?