API Übersicht

Diese 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- 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 den x-api-key Header

Beispiel:

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

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

Der authorization Header wird für ältere API-Schlüssel noch akzeptiert, aber x-api-key ist die empfohlene Kopfzeile 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 Anfragen pro Minute für Standardkonten
• 1000 Anfragen pro Minute für Enterprise-Konten

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

Gerätekanaländerungen

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

• Ein Gerät kann bis zu 5 Anfragen pro Sekunde für jede Kanaloperation (set, get, delete, oder list. Diese Grenze ist auf die App, das Gerät und die Operation beschränkt.
• Die Einstellung des gleichen Geräts auf die gleiche Kanal mehr als einmal innerhalb von 60 Sekunden ergibt eine 429-Antwort. Die Umstellung auf einen anderen Kanal ist nach dem Neustart der pro-Sekunden-Grenze erlaubt.
• Ein zusätzlicher Grenzwert von 1000 Kanal-Anfragen pro Minute gilt für jede App und IP-Adresse.

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 Dauer in der 429-Antwort, bevor Sie erneut versuchen. retryAfterSeconds Antwortformat

Abschnitt mit dem Titel „Antwortformat“

Objekt oder ein data Feld. Fehlerantworten enthalten ein status Feld mit einer Beschreibung dessen, was schief gelaufen ist. error Beispiel für eine erfolgreiche Antwort:

Beispiel für eine erfolgreiche Antwort:

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

Beispiel für eine Fehlerantwort:

{
  "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 widerrufen für sichere Zugriffe auf den Capgo API

Mitglieder Verwalten Sie Organisationen, Rollen und Berechtigungen

Statistiken Zugriff auf detaillierte Analysen zur App-Nutzung, -speicherung und -bandbreitenverbrauch

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

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

Pakete Paketverwaltung, einschließlich Hochladen, Auflisten und Verwalten von Paketen (Versionen)

Empfehlungen zur Optimierung

1. : Überprüfen Sie immer auf Fehlerantworten und behandeln Sie sie entsprechendRate-Limits
2. Best Practices: Implement exponentielle Rückschlagsstrategie bei Rate-Limits-Ereignissen
3. Caching: Cache Antworten, um API-Aufrufe zu reduzieren
4. Versionierung: Verfolgen Sie API-Änderungen über unsere Changelog-Übersicht

Fortsetzung aus der API-Übersicht

Wenn Sie __CAPGO_KEEP_0__ verwenden API-Übersicht um Authentifizierungs- und Kontoflows zu planen, verbinden Sie es mit @capgo/capacitor-social-login zur Implementierungsdetail 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 der Zwei-Faktor-Authentifizierung und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).