API Présentation

Ceci est la documentation de l'API publique API de Capgo cloud. L'API API vous permet de gérer de manière programmée vos ressources Capgo, y compris les organisations, les appareils, les canaux et les lots. Elle est conçue pour être RESTful et utilise les méthodes HTTP standard.

Authentification

Toutes les API API nécessitent une authentification. Pour authentifier vos requêtes, ajoutez votre clé API dans l'en-tête. authorization Exemple :

Fenêtre de terminal

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

Obtenez la clé API Générez votre clé API dans le tableau de bord Capgo

Limitation de taux

Le API met en œuvre une limitation de taux pour garantir un usage équitable. Les limites actuelles sont :

• 100 requêtes par minute pour les comptes standard
• 1000 requêtes par minute pour les comptes entreprises

Si vous dépasssez ces limites, vous recevrez une réponse 429 (Trop de requêtes)

Format de réponse

Toutes les réponses sont au format JSON. Les réponses réussies incluent généralement soit un data objet ou un status field. Les réponses d'erreur incluent un error field avec une description de ce qui s'est mal passé.

Exemple de réponse de succès :

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

Exemple de réponse d'erreur :

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

Points de terminaison disponibles

Organisations Créer et gérer les organisations, mettre à jour les paramètres et gérer les configurations au niveau de l'organisation

API Clés Générer, lister et révoquer les API clés pour un accès sécurisé à la Capgo API

Membres Gérer les membres de l'organisation, les rôles et les permissions

Statistiques Accéder à des statistiques détaillées sur l'utilisation de l'application, la consommation de stockage et de bande passante

Canaux Contrôler les canaux d'actualisation de l'application, les lots (versions) et les politiques d'actualisation

Appareils Suivre et gérer les appareils exécutant votre application, y compris les affectations de lot (version) et de canal

Lots Gérer les lots de l'application, y compris l'upload, la liste et la gestion des lots (versions)

Meilleures Pratiques

1. Gestion des Erreurs: Vérifiez toujours les réponses d'erreur et traitez-les en conséquence
2. Limitation de Taux: Implémentez un recul exponentiel lorsque vous atteignez les limites de taux
3. Caching: Cachez les réponses lorsque cela est approprié pour réduire les appels API
4. Versionnement: Suivez les modifications de API à travers notre changelog