API Panoramica

Questa è la documentazione del pubblico API di Capgo cloud. Il API consente di gestire in modo programmatico le tue risorse Capgo, compresi gli organizzatori, 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 authorization testata.

Esempio:

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

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

Limiti di Rate

Il API implementa i limiti di rate per garantire un utilizzo equo. I limiti attuali sono:

• 100 richieste per minuto per gli account standard
• 1000 richieste per minuto per gli account enterprise

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

Formato della Risposta

Tutte le risposte sono in formato JSON. Le risposte di successo includono generalmente 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 statistiche dettagliate sull'uso dell'app, sullo storage e sul consumo di banda

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

Dispositivi Segui e gestisci i dispositivi che eseguono la tua app, compresi gli assegnamenti di bundle (versione) e canale

Bundles Gestisci i bundle dell'app, compreso l'upload, la lista e la gestione dei bundle (versioni)

Prassi Migliorate

1. Gestione degli ErroriVerifica sempre le risposte di errore e gestiscile in modo appropriato
2. Limitazione dei Rate: Implementare il ritardo esponenziale quando si superano i limiti dei rate
3. Caching: Memorizzare le risposte quando opportuno per ridurre API chiamate
4. Versioning: Tenere traccia dei cambiamenti di API attraverso il nostro changelog