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- 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/

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

Der authorization Der 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 sicherer hashierter Schlüssel.

Grenzwertbegrenzung

Das API implementiert Grenzwertbegrenzungen, um eine faire Nutzung sicherzustellen. Aktuelle Grenzwerte sind:

• 100 Anforderungen pro Minute für Standardkonten
• 1000 Anforderungen pro Minute für Enterprise-Konten

If Sie diese Grenzen überschreiten, erhalten Sie eine 429 (Zu viele Anforderungen) Antwort.

Gerätekanaländerungen

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

• Eine Geräte kann bis zu 5 Anfragen pro Sekunde für jede Kanaloperation (set, get, delete, oder list) ausführen. Diese Grenze ist auf die App, das Gerät und die Operation beschränkt.
• Bei der Einstellung des gleichen Geräts auf den gleichen Kanal mehr als einmal innerhalb von 60 Sekunden wird eine 429-Antwort zurückgegeben. Die Umstellung auf einen anderen Kanal ist nach dem Neustart der pro-Sekunden-Grenze erlaubt.
• Eine zusätzliche Grenze 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 retryAfterSeconds Dauer 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. Fehlerhafte Antworten 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 von Einstellungen und Organisationseinstellungen bearbeiten

API Schlüssel Erstellen, Liste und API Schlüssel für sichere Zugriff auf Capgo API abrufen

Mitglieder Verwalten Sie Organisationen, Rollen und Berechtigungen

Statistiken Zugriff auf detaillierte Analysen zu App-Verwendung, Speicherplatz und Bandbreitenverbrauch

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

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

Pakete Verwalten Sie App-Bundles, einschließlich Hochladen, Auflisten und Verwalten von Bundeln (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 geeignet ist, um API-Aufrufe zu reduzieren
4. Versionsverwaltung: Verfolgen Sie API-Änderungen über unsere Versionsgeschichte

Weitermachen von API-Übersicht

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