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, compresi gli organi, 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/

Get API key Genera la tua chiave API nella dashboard Capgo

La authorization l'intestazione è ancora accettata per le chiavi legacy API, ma x-api-key è la intestazione consigliata per tutte le tipologie di chiave, comprese le chiavi crittografate.

Limitazione del Tasso

L'API implementa il limite di velocità per garantire un utilizzo equo. I limiti attuali sono:

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

Se superate questi limiti, riceverete una risposta 429 (Troppi richieste)

Modifiche del canale dispositivo

Canali di dispositivo cambiano utilizzano il plugin API e hanno limiti di prevenzione dall'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.
• Impostare 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 switch del canale può tornare a un canale selezionato di recente, aspetta il retryAfterSeconds duration nella risposta 429 prima di riprovare.

Formato della Risposta

Tutte le risposte sono in formato JSON. Le risposte riuscite includono di solito sia un data oggetto o un' status field. Error responses include an error campo con una descrizione di cosa è andato storto.

Punti di Accesso Disponibili

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

Formato della Risposta

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

Sezione intitolata “Formato della Risposta”

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

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

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

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

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

Dispositivi Gestire i dispositivi che eseguono l'applicazione, compresi gli assegnamenti di pacchetto (versione) e canale

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

Pratiche Raccomandate

1. Gestione degli Errori: Controlla sempre le risposte di errore e gestiscile in modo appropriato
2. Limitazione della VelocitàImplementare backoff esponenziale quando si superano i limiti di tasso
3. CachingCaching le risposte quando opportuno per ridurre i chiamate API
4. Versionamento: Tieni traccia dei cambiamenti a API attraverso il nostro changelog

Continua da API Panoramica

Se stai utilizzando API Panoramica 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-chiave-pass per i dettagli di implementazione in @ capgo/ capacitor-chiave-pass @ capgo/ capacitor-biometrica-nativa per i dettagli di implementazione in @ capgo/ capacitor-biometrica-nativa Autenticazione a due fattori per i dettagli di implementazione in due fattori di autenticazione, e SSO (azienda) per i dettagli di implementazione in SSO (azienda).