API Présentation

Il s’agit de la documentation du cloud public API du Capgo. Le API vous permet de gérer par programmation vos ressources Capgo, y compris les organisations, les appareils, les canaux et les offres groupées. Il est conçu pour être RESTful et utilise des méthodes HTTP standard.

Authentification

Tous les points de terminaison API nécessitent une authentification. Pour authentifier vos demandes, ajoutez votre clé API dans l’en-tête authorization.

Exemple :

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

Obtenez la clé API Generate your API key in the Capgo dashboard

Limitation du débit

Le API implémente une limitation de débit pour garantir une utilisation équitable. Les limites actuelles sont :

• 100 requêtes par minute pour les comptes standards
• 1 000 requêtes par minute pour les comptes d’entreprise

Si vous dépassez ces limites, vous recevrez une réponse 429 (trop de demandes).

Format de réponse

Toutes les réponses sont au format JSON. Les réponses réussies incluent généralement soit un objet data, soit un champ status. Les réponses d’erreur incluent un champ error avec une description de ce qui n’a pas fonctionné.

Exemple de réponse réussie :

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

Exemple de réponse d’erreur :

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

Points de terminaison disponibles

Organizations Create and manage organizations, update settings, and handle organization-level configurations

API Clés Generate, list, and revoke API keys for secure access to the Capgo API

Members Manage organization members, roles, and permissions

Statistiques Access detailed analytics about app usage, storage, and bandwidth consumption

Channels Control app update channels, bundles (versions), and update policies

Devices Track and manage devices running your app, including bundle (version) and channel assignments

Bundles Handle app bundles, including uploading, listing, and managing bundles (versions)

## meilleures pratiques

1. Gestion des erreurs : vérifiez toujours les réponses aux erreurs et gérez-les de manière appropriée
2. Limitation de débit : implémentez un recul exponentiel lorsque vous atteignez les limites de débit
3. Mise en cache : mettez en cache les réponses le cas échéant pour réduire les appels API
4. Gestion des versions : gardez une trace des modifications API grâce à notre journal des modifications