API Résumé

Ceci est la documentation du public API de Capgo cloud. Le API vous permet de gérer de manière programmée vos ressources Capgo, y compris les organisations, les appareils, les canaux et les ensembles. Il est conçu pour être RESTful et utilise les méthodes HTTP standard.

Authentification

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

Exemple :

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

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

L'en-tête est toujours acceptée pour les clés de legacy __CAPGO_KEEP_0__, mais authorization header is still accepted for legacy API keys, but x-api-key Limitation de taux

Limitation de taux d'authentification

La 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épassiez ces limites, vous recevrez une réponse 429 (Trop de requêtes).

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 sur l'application, l'appareil et l'opération.
• La mise en place du même appareil sur le même canal plus d'une fois dans les 60 secondes retourne une réponse 429. La mise en place sur un canal différent est autorisée après que la limite par seconde se réinitialise.
• Une limite supplémentaire de 1000 requêtes de canal par minute s'applique à chaque application et adresse IP.

Ces limites ne sont pas compte-ensemble. 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

Section intitulée “Format de réponse”

Exemple de réponse réussie : data Copier dans le presse-papier status Exemple de réponse d'erreur : error __CAPGO_KEEP_0__

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

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

Points d'entrée 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 aux statistiques détaillées sur l'utilisation de l'application, la consommation de stockage et de bande passante

Canaux Gérer les canaux d'actualisation de l'application, les ensembles (versions) et les politiques d'actualisation

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

Ensembles Gérez les ensembles d'application, 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. Caching: Stockez les réponses de cache lorsque cela est approprié pour réduire les appels API
4. Versioning: Suivez les modifications de API à travers notre changelog

Continuez à partir de l'aperçu de API

Si vous utilisez API Aperçu 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-native-biometrique pour les détails d'implémentation dans @capgo/capacitor-native-biometrique Authentification à deux facteurs pour les détails d'implémentation dans Authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).