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 konzipiert und verwendet standardmäßige HTTP-Methode.

Authentifizierung

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

Beispiel:

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

Erhalten Sie die API-Schlüssel Generieren Sie Ihre 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 Anforderungen pro Minute für Enterprise-Konten

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

Antwortformat

Alle Antworten sind im JSON-Format. Erfolgreiche Antworten enthalten in der Regel entweder eine data Objekt oder ein Feld. Fehlerantworten enthalten ein Feld mit einer Beschreibung dessen, was schief gelaufen ist. status Feld mit einer Beschreibung dessen, was schief gelaufen ist. error Beispiel für eine erfolgreiche Antwort:

Zur Zwischenablage kopieren

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

Zur Zwischenablage kopieren

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

Abschnitt mit dem Titel „Verfügbare Endpunkte“

Erstellen und verwalten Sie Organisationen, aktualisieren Sie Einstellungen und bearbeiten Sie organisationsebene Konfigurationen Schlüssel

API Schlüssel Erstellen, auflisten und widerrufen Sie API-Schlüssel für sichere Zugriffe auf die Capgo API

Mitglieder Organisationsmitglieder, Rollen und Berechtigungen verwalten

Statistiken Detaillierte Analysen zu App-Verwendung, Speicherplatz und Bandbreitenverbrauch erhalten

Kanäle App-Update-Kanäle, Pakete (Versionen) und Update-Politiken steuern

Geräte Geräte, die Ihre App ausführen, einschließlich Paket- (Version-) und Kanalzuweisungen verwalten

Pakete Paket-Verwaltung, einschließlich Hochladen, Auflisten und Verwalten von Paketen (Versionen)

Gute Praktiken

1. Fehlerbehandlung: Überprüfen Sie immer auf Fehlerantworten und behandeln Sie sie entsprechend
2. Rate Limiting: Implementieren Sie einen exponentiellen Backoff, wenn Sie Rate Limits erreichen
3. Caching: Cachen Sie Antworten, wenn dies sinnvoll ist, um API-Aufrufe zu reduzieren
4. Versionierung: Verfolgen Sie API-Änderungen über unsere Changelog