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

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

Exemple :

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 l'en-tête est toujours accepté 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

L’API implémente une limitation de taux pour garantir un usage équitable. Les limites actuelles sont :

• 100 requêtes par minute pour les comptes standards
• 1 000 requêtes par minute pour les comptes entreprises

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

Changements de canal de dispositif

Le canal de périphérique utilise le plugin API et a des limites de prévention de l'abus séparées 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, deleteou list). Cette limite est scoping sur l'application, l'appareil et l'opération.
• La mise à la même canalisation d'un appareil plus d'une fois en 60 secondes renvoie une réponse 429. La passerelle vers un autre canal est autorisée après que la limite par seconde se soit réinitialisée.
• Une limite supplémentaire de 1 000 requêtes de canal par minute s'applique à chaque application et adresse IP.

Ces limites ne sont pas compte-entreprise. 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 data un objet ou un status Copier dans le presse-papier error champ avec une description de ce qui s'est mal passé.

Points d'entrée disponibles

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

Copier dans le presse-papier

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

Exemple de réponse d'erreur :

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

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

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

Statistiques Access detailed analytics about app usage, storage, and bandwidth consumption

Canaux Control app update channels, bundles (versions), and update policies

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

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

Meilleures Pratiques

1. Gestion des ErreursToujours vérifiez les réponses d'erreur et gérez-les en conséquence
2. Limitation de TauxImplémentez un backoff exponentiel lors de la limite de taux d'atteinte.
3. CacheCachez les réponses lorsque cela est approprié pour réduire les appels à API
4. VersionnementSuivez les modifications de API à travers notre changelog

Continuez de là depuis API Vue d'ensemble

Si vous utilisez API Vue d'ensemble pour planifier les flux d'authentification et de compte, connectez-l’à @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-authentification-native pour les détails d'implémentation dans @capgo/capacitor-authentification-native, Authentification à deux facteurs pour les détails d'implémentation dans la deuxième factor d'authentification, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).