API Überblick

Dies ist die Dokumentation des öffentlichen API von Capgo Cloud. Das API ermöglicht Ihnen die programmatische Verwaltung Ihrer Capgo-Ressourcen, 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 x-api-key Header

Beispiel:

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

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

The authorization Überschrift wird weiterhin für legale API-Schlüssel akzeptiert, aber x-api-key ist die empfohlene Überschrift für alle Schlüsseltypen, einschließlich sicher gehashter Schlüssel.

Rate Limiting

Die API implementiert eine Rate Limitierung, 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 typischerweise entweder ein 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:

Zum Clipboard kopieren

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

Zum Clipboard 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 __CAPGO_KEEP_0__ Schlüssel

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

Mitglieder Verwalten Sie die Mitglieder, Rollen und Berechtigungen der Organisation

Statistiken Zugriff auf detaillierte Analysen zur App-Nutzung, Speicherplatz und Bandbreitenverbrauch

Kanäle Kontrollieren Sie die App-Update-Kanäle, Bundles (Versionen) und Update-Politiken

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

Bundles Verwalten Sie App-Bundles, einschließlich des Hochladens, Auflistens und Verwaltens von Bundles (Versionen)

Best Practices

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: Cache Antworten, wenn dies angebracht ist, um API Aufrufe zu reduzieren
4. Versionierung: Verfolgen Sie API-Änderungen über unsere Changelog

Weiter von API Übersicht

Wenn Sie __CAPGO_KEEP_0__ verwenden API Übersicht um die Authentifizierung und die Kontenflüsse zu planen, verbinden Sie es mit @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-social-login, @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometric, Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung, und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).