API Panoramica

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

Autenticazione

Tutti i punti di fine API richiedono l'autenticazione. Per autenticare le tue richieste, aggiungi la tua API chiave nella x-api-key header.

Esempio:

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

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

Il authorization La intestazione è ancora accettata per le chiavi legacy API, ma x-api-key è la intestazione raccomandata per tutti i tipi di chiave, comprese le chiavi hash sicure.

Limitazione del tasso

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

• 100 richieste per minuto per conti standard
• 1000 richieste per minuto per conti enterprise

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

Formato della Risposta

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

Esempio di risposta di successo:

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

Esempio di risposta di errore:

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

Punti di accesso disponibili

Organizzazioni Crea e gestisci organizzazioni, aggiorna le impostazioni e gestisci le configurazioni a livello di organizzazione

API Chiavi 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'applicazione, 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 la tua app, inclusi le assegnazioni di pacchetti (versioni) e canali

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

Pratiche consigliate

1. : Controlla sempre le risposte degli errori e gestiscile in modo appropriatoLimitazione del tasso
2. : Implementa l'allontanamento esponenziale quando si colpiscono i limiti del tassoCaching
3. __CAPGO_KEEP_0__: Risparmia le risposte della cache quando opportuno per ridurre API chiamate
4. Versioning: Traccia i cambiamenti di API attraverso il nostro changelog

Continua dall'Overview di API

Se stai utilizzando Overview di API per pianificare l'autenticazione e le flussi di account, connettilo con @capgo/capacitor-login-sociale per i dettagli di implementazione in @capgo/capacitor-login-sociale, @capgo/capacitor-passkey per i dettagli di implementazione in @capgo/capacitor-passkey @capgo/capacitor-biometrica nativa per i dettagli di implementazione in @capgo/capacitor-biometrica nativa Autenticazione a due fattori per i dettagli di implementazione in Autenticazione a due fattori, e SSO (azienda) per i dettagli di implementazione in SSO (azienda).