API Übersicht

Diese ist die Dokumentation der öffentlichen API von Capgo Cloud. Die API ermöglicht es Ihnen, Ihre Capgo Ressourcen programmatisch zu verwalten, einschließlich Organisationen, Geräten, Kanälen und Paketen. Sie 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 ein.

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 auch für legacy API-Schlüssel akzeptiert, aber x-api-key ist die empfohlene Header 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 anwenden, einschließlich von Testkonten:

• Eine Geräte 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.
• Setzen Sie das gleiche Gerät auf die gleiche Kanal mehr als einmal innerhalb von 60 Sekunden zurück, wird eine 429-Antwort zurückgegeben. 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 Sektor mit dem Titel „Antwortformat“

Alle Antworten sind im JSON-Format. Erfolgreiche Antworten enthalten typischerweise entweder ein

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

Beispiel für eine erfolgreiche Antwort:

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

Beispielhafte 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 Generieren, auflisten und API Schlüssel 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 Pakete verwalten, einschließlich Hochladen, Auflisten und Verwalten von Paketen (Versionen)

Best Practices

1. FehlerbehandlungStellen Sie immer sicher, dass Sie auf Fehlerantworten reagieren und sie entsprechend behandeln
2. Rate Limiting: Implement exponentielle Rückschlagsstrategie bei Rate-Limits-Einhalten
3. Caching: Cache Antworten, wenn geeignet, um API-Aufrufe zu reduzieren
4. Versionierung: Verfolgen Sie API-Änderungen über unsere Changelog

Fortsetzen Sie von API-Übersicht

Wenn Sie __CAPGO_KEEP_0__-Übersicht verwenden API Overview @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login zur Implementierungsdetail in @capgo/capacitor-social-login, for the implementation detail 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).