API Panoramica

Questa è la documentazione del pubblico API di Capgo cloud. Il API consente di gestire in modo programmatico le tue risorse Capgo, compresi gli organizzatori, i dispositivi, i canali e i 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 nella x-api-key testa.

Esempio:

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

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

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

Limitazione del tasso

La API implementa la limitazione del tasso per garantire l'uso equo. I limiti attuali sono:

• 100 richieste al minuto per gli account standard
• 1000 richieste per minuto per conti aziendali

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 delle organizzazioni, i ruoli e le autorizzazioni

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

Canali Controlla i canali di aggiornamento dell'app, i bundle (versioni) e le politiche di aggiornamento

Dispositivi Segui e gestisci i dispositivi che eseguono la tua app, compresi gli assegnamenti di bundle (versione) e canale

Bundles Gestisci i bundle dell'app, compresi l'upload, la lista e la gestione dei bundle (versioni)

Prassi Raccomandate

1. Gestione degli ErroriControlla sempre le risposte degli errori e gestiscile in modo appropriato
2. Limitazione dei TassiImplementa l'allontanamento esponenziale quando si superano i limiti dei tassi
3. CachingCaching le risposte quando opportuno per ridurre API chiamate
4. Versioning: Keep track of API changes through our changelog

Continua da API Overview

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