API Panoramica

Questa è la documentazione del pubblico API di Capgo cloud. Il API consente di gestire in modo programmatico le risorse Capgo del tuo account, comprese organizzazioni, dispositivi, canali e pacchetti. È progettato per essere RESTful e utilizza metodi HTTP standard.

Autenticazione

Tutti i API endpoint richiedono l'autenticazione. Per autenticare le tue richieste, aggiungi la tua API chiave nel authorization header.

Esempio:

curl -H "authorization: your-api-key" https://api.capgo.app/organization/

Otteni la chiave API Genera la tua chiave API nella dashboard Capgo

Limitazione del tasso

La API implementa la limitazione del tasso per garantire un utilizzo equo. I limiti attuali sono:

• 100 richieste al minuto per gli account standard
• 1000 richieste al minuto per gli account enterprise

Se superi questi limiti, riceverai una risposta 429 (Troppi richieste)

Formato della Risposta

Tutte le risposte sono in formato JSON. Le risposte riuscite includono generalmente o data oggetto o un campo. Le risposte di errore includono un campo con una descrizione di cosa è andato storto. status campo. Le risposte di errore includono un campo con una descrizione di cosa è andato storto. error Esempio di risposta di successo:

Copia nel portapenna

{
  "status": "ok",
  "data": { ... }
}

Copia nel portapenna

{
  "error": "Invalid API key",
  "status": "KO"
}

Sezione intitolata “Punti di accesso disponibili”

Crea e gestisci organizzazioni, aggiorna le impostazioni e gestisci le configurazioni a livello di organizzazione. __CAPGO_KEEP_0__ Chiavi

API Keys Genera, elenca e revoca le API chiavi per un accesso sicuro al Capgo API

Membri Gestisci i membri dell'organizzazione, i ruoli e le autorizzazioni

Statistiche Accedi a statistiche dettagliate sull'utilizzo dell'app, sullo storage e sul consumo di banda

Canali Gestisci i canali di aggiornamento dell'app, i pacchetti (versioni) e le politiche di aggiornamento

Dispositivi Segui e gestisci i dispositivi che eseguono l'app, compresi gli assegnamenti di pacchetto (versione) e canale

Pacchetti Gestisci i pacchetti dell'app, comprese l'upload, l'elenco e la gestione dei pacchetti (versioni)

Pratiche consigliate

1. Gestione degli Errori: Controlla sempre le risposte degli errori e gestiscile in modo appropriato
2. Limitazione dei Tassi: Implementa l'allontanamento esponenziale quando si colpiscono i limiti dei tassi
3. Caching: Cacha le risposte quando è appropriato per ridurre le chiamate a API
4. Versioning: Tieni traccia delle modifiche a API attraverso il nostro changelog

Continua da API Overview

Se stai utilizzando Riepilogo API per pianificare l'autenticazione e le flussi di account, connettilo con @capgo/capacitor-login-social per i dettagli di implementazione in @capgo/capacitor-social-login, @capgo/capacitor-passkey per i dettagli di implementazione in @capgo/capacitor-passkey, @capgo/capacitor-biometric-nativo per i dettagli di implementazione in @capgo/capacitor-native-biometric, Autenticazione a due fattori per i dettagli di implementazione in Autenticazione a due fattori, e SSO (Enterprise) per i dettagli di implementazione in SSO (Enterprise).