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

Die authorization Kopfzeile wird auch für legale API-Schlüssel akzeptiert, aber x-api-key ist die empfohlene Header für alle Schlüsseltypen, einschließlich sicher gehashter Schlüssel.

Rate Limitierung

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.
• 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:

__CAPGO_KEEP_0__

{
  "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 die Capgo API

Mitglieder Verwalten Sie Organisationen, Rollen und Berechtigungen

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

Kanäle Kontext: Capgo-Kanäle-Funktion. Seite/Bereich: Capgo-Lösungen-Marketingseite. Rolle: Kurzer UI-Label oder Navigationselement. Gesehen in: Seite solutions/white-label.astro. Nachrichtenschlüssel `solutions_white_label_visual_cell2_value` (Solutions White Label Visual Cell2 Wert).

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

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

Pakete für Ihre App verwalten, einschließlich Hochladen, Auflisten und Verwalten von Paketen (Versionen)

1. Best Practices-SektionFehlerbehandlung
2. Stets auf Fehlerantworten prüfen und sie entsprechend behandeln. :: Implement exponentielle Rückschlagsstrategie bei Rate-Limits
3. Caching: Antworten speichern, wenn geeignet, um API Aufrufe zu reduzieren
4. Versionierung: Verfolgen Sie die API-Änderungen über unsere Versionsgeschichte

Weiter von API Übersicht

Wenn Sie __CAPGO_KEEP_0__ Übersicht API Übersicht zum Planen von Authentifizierung und Account-Flows verwenden, verbinden Sie es mit capgo/capacitor-social-login für die Implementierungsdetails 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).