Panoramica di API

Questa è la documentazione del pubblico API del Capgo cloud. Il API consente di gestire in modo programmatico le risorse Capgo del tuo cloud, comprese organizzazioni, dispositivi, canali e bundle. È 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/

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

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

Limiti di tasso

Il API implementa i limiti di tasso per garantire l'uso 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 richiesti)

Modifiche del canale dispositivo

Le modifiche del canale dispositivo utilizzano il plugin API e hanno limiti di prevenzione dell'abuso separati che si applicano a ogni piano, compresi i trial:

• Un dispositivo può effettuare fino a 5 richieste al secondo per ogni operazione del canale (set, get, delete, o list). Questo limite è limitato all'app, al dispositivo e all'operazione.
• Immettere lo stesso dispositivo sullo stesso canale più di una volta entro i 60 secondi restituisce una risposta 429. Passare a un canale diverso è consentito dopo che il limite di secondi si è resettato.
• Un limite aggiuntivo di 1000 richieste di canale per minuto si applica a ogni app e indirizzo IP.

Questi limiti non sono account-wide. Se il tuo switcher di canale può tornare a un canale selezionato di recente, attendi il retryAfterSeconds duration indicato nella risposta 429 prima di riprovare.

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

Aziende Creare e gestire le aziende, aggiornare le impostazioni e gestire le configurazioni a livello di azienda

API Chiavi Generare, elencare e revocare le API chiavi per un accesso sicuro al Capgo API

Utenti Gestire gli utenti dell'azienda, i ruoli e le autorizzazioni

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

Canali Controlla i canali di aggiornamento dell'applicazione, i pacchetti (versioni) e le politiche di aggiornamento

Dispositivi Segui e gestisci i dispositivi che eseguono il tuo'applicazione, compresi gli assegnamenti di pacchetto (versione) e canale

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

Prassi raccomandate

1. Gestione degli errori: Controlla sempre le risposte degli errori e gestiscile in modo appropriato
2. Limitazione del tasso: Implementa l'allontanamento esponenziale quando si colpiscono i limiti del tasso
3. Caching: Cache le risposte quando opportuno per ridurre le chiamate a API
4. Versioning: Tenere traccia dei cambiamenti a API attraverso il nostro 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 @ capgo/capacitor-login-social per i dettagli di implementazione in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric 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).