API Übersicht

Dies ist die Dokumentation des öffentlichen API von Capgo Cloud. Das API ermöglicht es Ihnen, Ihre Capgo-Ressourcen programmatisch zu verwalten, einschließlich Organisationen, Geräten, Kanälen und Paketen. Es ist für RESTful- und verwendet standardmäßige HTTP-Methode.

Authentifizierung

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

Beispiel:

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

Holen Sie sich Ihren API-Schlüssel Generieren Sie Ihren API-Schlüssel im Capgo-Dashboard

Grenzwertbegrenzung

Die API implementiert eine Grenzwertbegrenzung, um eine faire Nutzung sicherzustellen. Aktuelle Grenzwerte sind:

• 100 Anforderungen pro Minute für Standardkonten
• 1000 Anfragen pro Minute für Unternehmen

Wenn Sie diese Grenzen überschreiten, erhalten Sie eine 429 (Zu viele Anfragen) -Antwort.

Antwortformat

Alle Antworten sind im JSON-Format. Erfolgreiche Antworten enthalten typischerweise entweder ein data Objekt oder ein status Feld. Fehlerantworten enthalten ein error Feld mit einer Beschreibung dessen, was schief gelaufen ist.

Beispiel für eine erfolgreiche Antwort:

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

Beispiel für eine Fehlerantwort:

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

Verfügbare Endpunkte

Organisationen Erstellen und verwalten Sie Organisationen, aktualisieren Sie Einstellungen und bearbeiten Sie organisationsebene Konfigurationen

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

Mitglieder Verwalten Sie Organisationen-Mitglieder, Rollen und Berechtigungen

Statistiken Zugriff auf detaillierte Analysen zu App-Verwendung, Speicherplatz und Bandbreitenverbrauch

Kanäle Steuerung von App-Update-Kanälen, Bundle (Versionen) und Update-Politiken

Geräte Geräte, die Ihre App ausführen, einschließlich der Zuweisung von Paketen (Versionen) und Kanälen verwalten

Pakete Paketverwaltung, einschließlich Hochladen, Auflisten und Verwalten von Paketen (Versionen)

Gute Praktiken

1. FehlerbehandlungStets auf Fehlerantworten prüfen und sie entsprechend behandeln
2. Rate LimitingExponentielles Zurücksetzen bei Rate Limits implementieren
3. CachingAntworten, wenn möglich, cachieren, um API-Aufrufe zu reduzieren
4. Versionsverwaltung: Halten Sie sich über API Änderungen durch unsere Versionsgeschichte auf dem Laufenden