Panoramica API

Questa è la documentazione dell’API pubblica di Capgo cloud. L’API consente di gestire programmaticamente le tue risorse Capgo, incluse organizzazioni, dispositivi, canali e bundle. È progettata per essere RESTful e utilizza metodi HTTP standard.

Autenticazione

Tutti gli endpoint API richiedono autenticazione. Per autenticare le tue richieste, aggiungi la tua chiave API nell’header authorization.

Esempio:

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

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

Limitazione del tasso

L’API implementa la limitazione del tasso per garantire un uso equo. I limiti attuali sono:

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

Se superi questi limiti, riceverai una risposta 429 (Too Many Requests).

Formato della risposta

Tutte le risposte sono in formato JSON. Le risposte di successo in genere includono un oggetto data o un campo status. Le risposte di errore includono un campo error 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"
}

Endpoint disponibili

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

Chiavi API Genera, elenca e revoca chiavi API per l'accesso sicuro all'API Capgo

Membri Gestisci i membri dell'organizzazione, i ruoli e i permessi

Statistiche Accedi ad analisi dettagliate sull'utilizzo dell'app, lo storage e il consumo di larghezza di banda

Canali Controlla i canali di aggiornamento dell'app, le versioni e le politiche di aggiornamento

Dispositivi Traccia e gestisci i dispositivi che eseguono la tua app, incluse le assegnazioni di versione e canale

Bundle Gestisci i bundle delle app, incluso il caricamento, l'elenco e la gestione delle versioni

Best practice

1. Gestione degli errori: Controlla sempre le risposte di errore e gestiscile in modo appropriato
2. Limitazione del tasso: Implementa il backoff esponenziale quando si raggiungono i limiti di tasso
3. Caching: Memorizza in cache le risposte quando appropriato per ridurre le chiamate API
4. Versionamento: Tieni traccia delle modifiche API tramite il nostro changelog