API Présentation

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

All API endpoints require authentication. To authenticate your requests, add your API key in the x-api-key en-tête.

Exemple :

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

Get API key Generate your API key in the Capgo dashboard

L' authorization header is still accepted for legacy API keys, but x-api-key est la tête recommandée pour tous les types de clés, y compris les clés hachées sécurisées.

Limitation de taux

L’API met en œuvre la 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épassiez ces limites, vous recevrez une réponse 429 (Trop de requêtes).

Changements de canal de périphérique

Les changements de canal de périphérique 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, au dispositif et à l'opération.
• En définissant le même appareil sur le même canal plus d'une fois dans les 60 secondes, vous obtenez une réponse 429. La passer à un autre canal est autorisé après que le délai par seconde se soit réinitialisé.
• Une limite supplémentaire de 1000 demandes de canal par minute s'applique à chaque application et adresse IP.

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

Tout format de réponse est en JSON. Les réponses réussies incluent généralement soit un objet, soit un champ. Les réponses d'erreur incluent un champ avec une description de ce qui s'est mal passé.

Exemple de réponse réussie : data Exemple de réponse réussie : status Exemple de réponse réussie : error Exemple de réponse réussie :

Format de réponse

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

Réponse d'erreur d'exemple :

{
  "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é au Capgo API

Membres Gérer 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, le 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 lots (versions) et de canaux

Lots Gérez 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 gérez-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 journal des changements

Continuez depuis l'aperçu de API

Si vous utilisez l'aperçu de API pour planifier l'authentification et les flux de compte, connectez-l’avec @capgo/capacitor-connexion-social pour les détails d'implémentation dans @capgo/capacitor-connexion-social, capgo/capacitor-passkey pour les détails d'implémentation dans capgo/capacitor-passkey capgo/capacitor-native-biometric pour les détails d'implémentation dans capgo/capacitor-native-biometric 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).