API-Übersicht

Dies ist die Dokumentation der öffentlichen API von Capgo Cloud. Die API ermöglicht es Ihnen, Ihre Capgo-Ressourcen programmatisch zu verwalten, einschließlich Organisationen, Geräten, Kanälen und Bundles. Sie ist RESTful gestaltet und verwendet Standard-HTTP-Methoden.

Authentifizierung

Alle API-Endpunkte erfordern eine Authentifizierung. Um Ihre Anfragen zu authentifizieren, fügen Sie Ihren API-Schlüssel im authorization-Header hinzu.

Beispiel:

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

API-Schlüssel erhalten Generieren Sie Ihren API-Schlüssel im Capgo-Dashboard

Ratenbegrenzung

Die API implementiert Ratenbegrenzungen, um eine faire Nutzung zu gewährleisten. Aktuelle Limits sind:

100 Anfragen pro Minute für Standardkonten
1000 Anfragen pro Minute für Unternehmenskonten

Wenn Sie diese Limits überschreiten, erhalten Sie eine 429 (Too Many Requests)-Antwort.

Antwortformat

Alle Antworten sind im JSON-Format. Erfolgreiche Antworten enthalten normalerweise entweder ein data-Objekt oder ein status-Feld. Fehlerantworten enthalten ein error-Feld mit einer Beschreibung des Problems.

Beispiel erfolgreiche Antwort:

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

Beispiel Fehlerantwort:

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

Verfügbare Endpunkte

Organisationen Erstellen und verwalten Sie Organisationen, aktualisieren Sie Einstellungen und handhaben Sie Konfigurationen auf Organisationsebene

API-Schlüssel Generieren, listen und widerrufen Sie API-Schlüssel für sicheren Zugriff auf die Capgo-API

Mitglieder Verwalten Sie Organisationsmitglieder, Rollen und Berechtigungen

Statistiken Greifen Sie auf detaillierte Analysen zur App-Nutzung, Speicherung und Bandbreitenverbrauch zu

Kanäle Steuern Sie App-Update-Kanäle, Versionen und Update-Richtlinien

Geräte Verfolgen und verwalten Sie Geräte, auf denen Ihre App läuft, einschließlich Versions- und Kanalzuweisungen

Bundles Verwalten Sie App-Bundles, einschließlich Hochladen, Auflisten und Verwalten von Versionen

Best Practices

Fehlerbehandlung: Prüfen Sie immer auf Fehlerantworten und behandeln Sie diese angemessen
Ratenbegrenzung: Implementieren Sie exponentielles Backoff bei Erreichen von Ratenlimits
Caching: Cachen Sie Antworten, wenn angemessen, um API-Aufrufe zu reduzieren
Versionierung: Verfolgen Sie API-Änderungen über unser Changelog