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, Appareils, Canaux, and Bundles. It’s designed to be RESTful and uses standard HTTP methods.

Authentication

All API endpoints require authentication. To authenticate your requests, add your API key in the authorization header.

Exemple:

curl -H "authorization: your-api-key" https://api.capgo.app/organization/

Get Clé API Generate your Clé API in the Capgo Tableau de bord

Rate Limiting

The API implements rate limiting to ensure fair Utilisation. Current limits are:

• 100 requests per minute for standard accounts
• 1000 requests per minute for Entreprise accounts

If you exceed these limits, you’ll receive a 429 (Too Many Requests) response.

Response Format

All responses are in JSON format. Successful responses typically include either a data object or a status field. Error responses include an error field with a description of what went wrong.

Exemple Succès response:

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

Exemple Erreur response:

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

Disponible Endpoints

Organizations Créer and manage organizations, Mise à jour Paramètres, and handle Organisation-level configurations

Clés API Generate, list, and revoke Clés API for secure access to the Capgo API

Membres Manage Organisation Membres, roles, and permissions

Statistiques Access detailed Analyse À propos Application Utilisation, storage, and bandwidth consumption

Canaux Control Application Mise à jour Canaux, versions, and Mise à jour policies

Appareils Track and manage Appareils running your Application, including Version and Canal assignments

Bundles Handle Application Bundles, including uploading, listing, and managing versions

Best Practices

1. Erreur Handling: Always Vérifier for Erreur responses and handle them appropriately
2. Rate Limiting: Implement exponential backoff when hitting rate limits
3. Caching: Cache responses when appropriate to reduce API calls
4. Versioning: Keep track of API changes through our changelog