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 API endpoint 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 API chiave Genera la tua API chiave nel Capgo dashboard

Il authorization header è ancora accettato per le chiavi legacy API, ma x-api-key è il header raccomandato per tutti i tipi di chiave, comprese le chiavi sicure hashate.

Limitazione del tasso

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

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

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

Modifica 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 di canale (”,”, o”). Questo limite è limitato all'app, al dispositivo e all'operazione.set, get, deleteImpostare lo stesso dispositivo sullo stesso canale più di una volta entro 60 secondi restituisce una risposta 429. L'aggiornamento al canale diverso è consentito dopo che il limite di secondi si è resettato. listModifica del canale dispositivo utilizza il plugin __CAPGO_KEEP_0__ e ha 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 di canale (”,”, o”). Questo limite è limitato all'app, al dispositivo e all'operazione.
• Si applica un ulteriore limite di 1000 richieste di canale per minuto per ogni app e indirizzo IP.

Questi limiti non sono account-wide. Se il tuo switcher di canali 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 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 le 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'app, sullo storage e sul consumo di banda

Canali Gestisci canali di aggiornamento dell'app, bundle (versioni) e politiche di aggiornamento

Dispositivi Segui e gestisci dispositivi che eseguono la tua app, inclusi assegnamenti di bundle (versione) e canali

Bundle Gestisci bundle dell'app, inclusi caricamento, elenco e gestione di bundle (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: Risparmia le risposte della cache quando opportuno per ridurre API chiamate
4. Versioning: Traccia i cambiamenti di API attraverso il nostro changelog

Continua dall'API Overview

Se stai utilizzando API Overview 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-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 (Azienda) per i dettagli di implementazione in SSO (Azienda).