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. x-api-key Exemple:

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

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

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

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

Limitation de taux

La API met en œuvre la limitation de taux pour s'assurer d'un usage équitable. Les limites actuelles sont :

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

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

Changements de canal de dispositif

Les changements de canal de dispositif utilisent le plugin API et ont des limites de prévention de l'abus qui s'appliquent à chaque plan, y compris les essais :

• Un appareil peut effectuer jusqu'à 5 requêtes par seconde pour chaque opération de canal (set, get, delete, ou list). Cette limite est scoping à l'application, à l'appareil et à l'opération.
• La mise au même canal d'un appareil plus d'une fois dans les 60 secondes renvoie une réponse 429. La passerelle vers un canal différent est autorisée après que la limite par seconde se soit réinitialisée.
• Une limite supplémentaire de 1000 requêtes de canal par minute s'applique à chaque application et adresse IP.

Ces limites ne sont pas compteurs d'abonnement. Si votre passerelle de canal peut revenir à un canal sélectionné récemment, attendez la retryAfterSeconds durée indiquée dans la réponse 429 avant de réessayer.

Format de réponse

Toutes les réponses sont au format JSON. Les réponses réussies incluent généralement soit un objet ou un champ. Les réponses d'erreur incluent un champ avec une description de ce qui s'est mal passé. data Exemple de réponse réussie : status Copier dans le presse-papier error Exemple de réponse d'erreur :

Copier dans le presse-papier

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

Format de réponse

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

Exemple de réponse réussie :

Exemple de réponse d'erreur : 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 ensembles d'applications, y compris l'upload, la liste et la gestion des ensembles (versions)

Meilleures Pratiques

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. Cache: 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 les flux d'authentification et 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étrique-native pour les détails d'implémentation dans @capgo/capacitor-biométrique-native, L'authentification à deux facteurs pour les détails d'implémentation dans L'authentification à deux facteurs SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).