API Aperçu

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/

Générez votre clé API dans le tableau de bord __CAPGO_KEEP_1__ Generate your API key in the Capgo dashboard

La authorization En-tête est toujours acceptée pour les clés 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 hachées sécurisées.

Limitation de Taux

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

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 une erreur de champ inclut une error un champ 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 d'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 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. Gestion des limites de taux: Implémentez 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. Gestion de la version: Suivez les modifications de API à travers notre changelog

Continuez de 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étrique-natif pour les détails d'implémentation dans @capgo/capacitor-biométrique-natif, 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).