API Vue d'ensemble

This is the documentation of the public API of Capgo cloud. The API allows you to programmatically manage your Capgo resources, including organizations, devices, channels, and bundles. It’s designed to be RESTful and uses standard HTTP methods.

Authentification

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

Fenêtre de terminal

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

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

Le authorization l'en-tête est toujours acceptée pour les clés de legacy API, mais x-api-key est l'en-tête recommandée pour tous les types de clés, y compris les clés sécurisées hachées.

Limitation de Taux

Le API met en œuvre la limitation de taux pour s'assurer d'une utilisation équitable. Les limites actuelles sont :

• 100 requêtes par minute pour les comptes standard
• 1000 requêtes par minute pour les comptes d'entreprise

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

Format de la 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 champ. Les réponses d'erreur incluent un error champ avec une description de ce qui s'est mal passé.

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

Organisations Créez et gérez des organisations, mettez à jour les paramètres et gérez les configurations au niveau d'organisation

API Clés Générez, listez et révoquez les API clés pour un accès sécurisé au Capgo API

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

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

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

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

Lots Gérer les ensembles d'applications, y compris l'upload, la liste et la gestion des ensembles (versions)

Pratiques recommandées

1. Gestion des erreurs: Vérifiez toujours les réponses d'erreur et gérez-les en conséquence
2. Limitation de taux: Mettez en œuvre 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

Continuez à partir de l'API Overview

Si vous utilisez API Overview pour planifier l'authentification et les flux de compte, connectez-le avec @capgo/capacitor-login-social pour les détails d'implémentation dans @capgo/capacitor-login-social, @capgo/capacitor-passkey pour les détails d'implémentation dans @capgo/capacitor-passkey, @capgo/capacitor-biométrie-native pour les détails d'implémentation dans @capgo/capacitor-biométrie-native, L'authentification à deux facteurs pour les détails d'implémentation dans L'authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).