API Übersicht

Dies ist die Dokumentation des öffentlichen API von Capgo Cloud. Das API ermöglicht 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 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

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

Rate Limiting

Die API implementiert eine Ratebegrenzung, 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.

Gerätekanaländerungen

Gerätekanaländerungen verwenden den Plugin API und haben separate Missbrauchsvorkehrungen, die auf jeden Plan, einschließlich Testkonten, anwendbar sind:

• Ein Gerät kann bis zu 5 Anforderungen pro Sekunde für jede Kanaloperation (set, get, delete, oder list) durchführen. Diese Grenze ist auf die App, das Gerät und die Operation beschränkt.
• Bei der Einstellung des gleichen Geräts auf die gleiche Kanal mehr als einmal innerhalb von 60 Sekunden wird eine 429-Antwort zurückgegeben. Das Wechseln auf einen anderen Kanal ist nach dem Neustart der pro-Sekunden-Grenzwert erlaubt.
• Für jeden App und IP-Adresse gilt eine zusätzliche Grenze von 1000 Kanal-Anfragen pro Minute.

Diese Grenzen sind nicht auf das gesamte Konto beschränkt. Wenn Ihr Kanalwechsler auf einen kürzlich ausgewählten Kanal zurückkehren kann, warten Sie auf die retryAfterSeconds Zeit in der 429-Antwort, bevor Sie erneut versuchen.

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 Fehlerantwort:

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

Verfügbare Endpunkte

Organisationen Organisationen erstellen und verwalten, Einstellungen aktualisieren und organisationsebene Konfigurationen verwalten

API Schlüssel API Schlüssel generieren, auflisten und für sicheren Zugriff auf die Capgo API widerrufen

Mitglieder Organisationenmitglieder, Rollen und Berechtigungen verwalten

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

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

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

Pakete App-Pakete verwalten, einschließlich Hochladen, Auflisten und Paket- (Version-) Verwaltung

Gute Praktiken

1. FehlerbehandlungStellen Sie immer sicher, dass Sie auf Fehlerantworten reagieren und behandeln Sie sie entsprechend
2. GrenzwertbegrenzungImplementieren Sie einen exponentiellen Backoff, wenn Sie Grenzwerte erreichen
3. Caching: Zwischenlagern Sie Antworten, wenn dies angebracht ist, um API-Aufrufe zu reduzieren
4. Versioning: Verfolgen Sie API-Änderungen über unsere Versionsgeschichte

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 Zweifaktor-Authentifizierung für die Implementierungsdetails in Zweifaktor-Authentifizierung und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).