API Panoramica

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

Autenticazione

Tutti i punti di accesso API 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 dashboard Capgo

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

Limitazione del tasso di richiesta

Il API implementa la limitazione del tasso di richiesta per garantire un utilizzo 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 richieste).

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, comprese le prove gratuite:

• Un dispositivo può effettuare fino a 5 richieste al secondo per ogni operazione del canale (set, get, delete, o list. Questo limite è riferito all'applicazione, al dispositivo e all'operazione.
• Impostando lo stesso dispositivo sullo stesso canale più di una volta entro i 60 secondi viene restituito un codice di risposta 429. È consentito passare a un canale diverso dopo che il limite di reset dei secondi si è resettato.
• Si applica inoltre un ulteriore limite di 1000 richieste di canale per minuto per ogni applicazione e indirizzo IP.

Questi limiti non sono account-wide. Se il tuo switcher di canale può tornare a un canale selezionato di recente, aspetta il retryAfterSeconds duration in the 429 response 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

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 informazioni dettagliate sull'uso dell'applicazione, 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 la tua app, compresi gli assegnamenti di pacchetto (versione) e canale

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

Pratiche raccomandate

1. Gestione degli erroriSempre controlla le risposte degli errori e gestiscile in modo appropriato
2. Limitazione del tasso: Implementa il ritardo esponenziale quando si superano i limiti di velocità
3. Caching: Cache le risposte quando è appropriato per ridurre le chiamate a API
4. Versioning: Traccia i cambiamenti di 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 per il dettaglio di implementazione in @capgo/capacitor-passkey @capgo/capacitor-native-biometric per il dettaglio di implementazione in @capgo/capacitor-native-biometric 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).