JSON-Sync Endpunkt

Starten einer Synchronisation ohne Login und Absprung zu Kontoflux.io

Mit dem JSON Endpunkt zum Synchronisieren kannst du den Sync komplett eingebettet in einer Applikation starten ohne dabei einen Absprung zu Kontoflux.io zu haben.

Du erhältst dabei in der Antwort des JSON Endpunkts auch Informationen über den Status des Syncs und die Menge der übertragenen Transaktionen.

Das Ausführen des Syncs kann ein paar Sekunden dauern. Der Request wird so lange offen gelassen. Ist der Sync nach 60 Sekunden noch nicht abgeschlossen, gibt der JSON-Endpunkt eine Schätzung zurück, wie lange der Sync dauern wird.

JSON Endpunkt Link generieren

Du musst zum nutzen des Endpunktes in der Integrationen nach erfolgreichen Einrichten einen Link generieren und kannst Ihn dann zum einbetten kopieren. Dabei wird ein Token generiert und automatisch der URL angehangen. Du kannst jederzeit den Token erneuern oder den Endpunkt gänzlich aktivieren durch Löschen des Tokens.

Parameter

Es funktionieren GET als auch POST Requests an den Endpunkt. Neben den Token, der als GET Parameter mit geschickt wird, sind keine weiteren Parameter notwendig.

JSON Antwort durchgeführten Sync

Sollte der Sync innerhalb einer Minute erledigt sein, käme direkt das Ergebnis des Syncs.

{
  "message": "integration sync finished",
  "items": 1568,
  "log": [
    "Log Entries...",
    "... of the Sync ...",
    "... as Array"
  ],
  "combinedLog": "Log Entries as single String"
}

JSON Antwort eingereihter Sync

Wenn ein Sync länger als eine Minute dauert, antwortet der JSON Endpunkt mit einer Zeitschätzung zu wann die Daten Synchronisiert sind.

{ 
    message: "integration is scheduled for sync. Estimate: 1 minute", 
    estimation: 1, 
    unit: "minutes" 
}