Zum Hauptinhalt springen
Eine Quelle synchronisiert eine App in einen Namespace: Neue und geänderte Datensätze werden geschrieben, gelöschte werden gelöscht. Quellen benötigen einen Schlüssel mit Vollzugriff; für einen Bucket siehe Google Cloud Storage.

Eine Quelle verbinden

POST /sources
Response
Leiten Sie den Eigentümer der App zu connect_url weiter (7 Tage gültig); die erste Synchronisierung startet, sobald er sich verbindet. Um die Apps Ihrer Nutzer zu verbinden, geben Sie jedem Nutzer einen Namespace, etwa user-42. Vollständiges Schema: Eine Quelle verbinden.

Synchronisierte Dokumente

Eine Quelle abrufen

GET /sources/:id
curl
Vollständiges Schema: Eine Quelle abrufen.

Quellen auflisten

GET /sources Gibt sources zurück, jeweils so, wie Get sie liefert; eine Quelle mit einem kind, etwa files oder gcs, hat stattdessen ein sync-Objekt. Vollständiges Schema: Quellen auflisten.

Jetzt synchronisieren

POST /sources/:id/sync Startet innerhalb von Sekunden eine Synchronisierung und gibt die Quelle zurück; eine Quelle im Status connecting gibt 409 conflict zurück. Vollständiges Schema: Eine Quelle jetzt synchronisieren.

Das Synchronisierungsintervall ändern

PATCH /sources/:id Gibt die Quelle zurück. Vollständiges Schema: Festlegen, wie oft eine Quelle synchronisiert.

Eine Quelle trennen

DELETE /sources/:id Beendet die Synchronisierung und gibt { "deleted": true } zurück. Vollständiges Schema: Eine Quelle trennen.

Die Apps auflisten

GET /sources/types
Response
  • Jede hat den type zum Verbinden, ihren name und logo_url sowie auth: "api_key" für Apps, die sich mit config verbinden.
  • partial ist true, wenn nur diese Apps aufgelistet werden konnten: Versuchen Sie es später erneut.
Vollständiges Schema: Quelltypen auflisten.