Schiffen Sie API-Apps ohne Wartezeit

Dokumentation des öffentlichen API von Capgo-Cloud. Das API ermöglicht Ihnen die programmatische Verwaltung Ihrer Capgo-Ressourcen, 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 Anforderungen 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 sicherer gehashter Schlüssel.

Grenzwertbegrenzung

Die API implementiert eine Rate Limitierung, 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 Missbrauchsvorbeugungsgrenzen, 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) durchführen. Diese Grenze ist auf die App, das Gerät und die Operation beschränkt.
• Einem Gerät wird derselbe Kanal mehr als einmal innerhalb von 60 Sekunden zugewiesen, wird eine 429-Antwort zurückgegeben. Das Wechseln zum 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 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 einen data Objekt oder ein status Feld. Fehlerantworten enthalten ein error Beispiel für eine erfolgreiche Antwort:

Zwischenablage kopieren

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

Beispielfehlerantwort:

{
  "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 widerrufen Sie API-Schlüssel für sicheren Zugriff auf die Capgo API

Mitglieder Verwalten Sie Organisationen-Mitglieder, Rollen und Berechtigungen

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

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

Geräte Geräte verfolgen und verwalten, einschließlich der Zuweisung von Paketen (Versionen) und Kanälen

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

Gute Praktiken

1. FehlerbehandlungStets auf Fehlerantworten prüfen und sie entsprechend behandeln
2. GrenzwertbegrenzungRate Limiting: Exponentielles Zurücksetzen bei Rate-Limits
3. Caching: Cache Antworten, wenn angebracht, um API Aufrufe zu reduzieren
4. Versionierung: Verfolgen Sie API-Änderungen durch unsere Änderungsprotokolle

Fortsetzen Sie mit der API Übersicht

Wenn Sie __CAPGO_KEEP_0__ Overview verwenden API Übersicht um die Authentifizierung und die Kontenflüsse zu planen, verbinden Sie es mit zur Implementierungsdetail in @capgo/capacitor-social-login, für die Implementierungsdetails in @capgo/capacitor-Social-Login, @capgo/capacitor-Passwort Für die Implementierungsdetails in @capgo/capacitor-Passwort, @capgo/capacitor-native-Biometrie Für die Implementierungsdetails in @capgo/capacitor-native-Biometrie, Zweifaktor-Authentifizierung Für die Implementierungsdetails in Zweifaktor-Authentifizierung und SSO (Unternehmen) für die Implementierungsdetails in SSO (Enterprise).