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 Anfragen zu authentifizieren, fügen Sie Ihren API-Schlüssel in der x-api-key Anforderungszeile ein.

Beispiel:

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

Erhalten Sie die API-Schlüssel Generieren Sie Ihren API-Schlüssel im Capgo-Dashboard

Der authorization Der Header wird für legale API-Schlüssel noch akzeptiert, aber x-api-key ist der empfohlene Header für alle Schlüsseltypen, einschließlich sicherer gehashter Schlüssel.

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 Enterprise-Konten

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 fehlerhafte Antwort:

{
  "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 Erstellen, auflisten und API Schlüssel für sichere Zugriffe 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, Paketen (Versionen) und Update-Politiken

Geräte Verfolgen und verwalten Sie Geräte, die Ihre App ausführen, einschließlich der Zuweisung von Paket (Version) und Kanal

Pakete Verwalten Sie App-Pakete, einschließlich dem Hochladen, Auflisten und Verwalten von Paketen (Versionen)

Gute Praktiken

1. Fehlerbehandlung: Überprüfen Sie immer auf Fehlerantworten und behandeln Sie sie entsprechend
2. Grenzwertbegrenzung: Implementieren Sie exponentielles Zurücksetzen, wenn Sie Grenzwerte erreichen
3. Zwischenspeichern: Zwischenspeichern Sie Antworten, wenn dies angebracht ist, um API-Aufrufe zu reduzieren
4. Versionsverwaltung: Halten Sie die API Änderungen durch unsere Versionsgeschichte auf dem Laufenden

Fortsetzen Sie 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 zur Implementierungsdetail in @capgo/capacitor-social-login, @capgo/capacitor-passkey zur Implementierungsdetail 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).