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 Header.

Beispiel:

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

Get API key Generieren Sie Ihren API-Schlüssel im Capgo-Dashboard

Der authorization Header wird auch für legacys 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 Rate-Begrenzung, 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 der Testversion, anwendbar sind:

• Ein Gerät kann bis zu 5 Anforderungen pro Sekunde für jede Kanaloperation (set, get, deleteoder list) ausführen. Diese Grenze ist auf die App, das Gerät und die Operation beschränkt.
• Das Setzen des gleichen Geräts auf denselben Kanal mehr als einmal innerhalb von 60 Sekunden ergibt eine 429-Antwort. Das Wechseln auf einen anderen Kanal ist nach dem Neustart der pro-Sekunden-Grenze erlaubt.
• Eine zusätzliche Einschränkung von 1000 Kanal-Anfragen pro Minute gilt für jede App und IP-Adresse.

Diese Grenzen gelten nicht für das gesamte Konto. Wenn Ihr Kanalwechsler zu einem kürzlich ausgewählten Kanal zurückkehren kann, warten Sie auf retryAfterSeconds Zeitdauer in der 429-Antwort vor erneuter Wiederholung.

Abschnitt mit dem Titel „Antwortformat“

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

Beispiel erfolgreicher 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 widerrufen, um sicheren Zugriff auf die Capgo API zu erhalten

Mitglieder Organisationen, Rollen und Berechtigungen verwalten

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

Kanäle Update-Kanal-, Bundle- (Version) - und Update-Politik steuern

Geräte Geräte verfolgen und verwalten, einschließlich der Zuweisung von Bundle- (Version) und Kanal

Bundles App-Bundles verwalten, einschließlich Hochladen, Auflisten und Verwalten von Bundles (Versionen)

Gute Praktiken

1. FehlerbehandlungStets auf Fehlerantworten prüfen und sie entsprechend behandeln
2. Rate LimitingRate Limiting: Exponentielles Zurücksetzen bei Rate-Limits
3. Caching: Cache Antworten, wenn angebracht, um API Aufrufe zu reduzieren
4. Versionsverwaltung: 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-Passwort für die Implementierungsdetails in @capgo/capacitor-passkey @capgo/capacitor-native-biometrische zur Implementierungsdetail in @capgo/capacitor-native-biometrische Zwei-Faktor-Authentifizierung zur Implementierungsdetail in Zwei-Faktor-Authentifizierung, und SSO (Unternehmen) zur Implementierungsdetail in SSO (Unternehmen).