Panoramica API

Questa è la documentazione del pubblico API di Capgo cloud. Il API consente di gestire in modo programmatico i propri Capgo risorse, compresi gli organi di controllo, 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 proprie richieste, aggiungi la tua API chiave nella authorization header.

Esempio:

curl -H "authorization: your-api-key" https://api.capgo.app/organization/

Ottieni la chiave API Genera la tua chiave API nel pannello di controllo Capgo

Limitazione dei ratei

Il API implementa la limitazione dei ratei 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 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 Creare e gestire le organizzazioni, aggiornare le impostazioni e gestire le configurazioni a livello di organizzazione

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

Member Gestire i membri dell'organizzazione, i ruoli e le autorizzazioni

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

Canali Gestire i canali di aggiornamento dell'applicazione, i bundle (versioni) e le politiche di aggiornamento

Dispositivi Seguire e gestire i dispositivi che eseguono l'applicazione, compresi gli assegnamenti di bundle (versione) e canali

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

Prassi Raccomandate

1. Gestione degli ErroriControlla sempre le risposte degli errori e gestiscile in modo appropriato
2. Limitazione della VelocitàImplementa l'allineamento esponenziale quando si superano i limiti di velocità
3. CachingCacha le risposte quando è appropriato per ridurre le chiamate a API
4. VersionamentoSegui le modifiche a API attraverso il nostro changelog