Beschreibung der Schnittstelle External-Sync
(auslaufend)

 

Die hier beschriebene Schnittstelle ist auslaufend und wir nicht mehr angeboten. Die Funktion der Schnittstelle ist jedoch bis auf Weiters gesichert. 

Wenn Sie Erstanwender der ThüCAT-Schnittstellen sind, infomieren Sie sich bitte über die Schnittstelle API-SYNC.

Unter https://cdb.thuecat.org/swagger finden Sie für die Schnittstelle External-Sync Schnittstellen-Interface. Dort können Sie die Schnittstelle testen und erhalten weitere nützliche Informationen zu den Datenstrukturen. 

Gehen Sie bei der Nutzung des Schnittstellen-Interface wie folgt vor:

Tragen Sie den API-Key ein und klicken Sie den Button "Explore".

Schnittstelle GET /ext-sync/get-updated-nodes

Nutzen die Schnittstelle GET /ext-sync/get-updated-nodes aus des dem Abschnitt External sync API.
Mit an dieser Schnittstelle stehen Ihnen alle Datenbankentitäten des Synchronisationsbereichs zur Verfügung.

Übergeben Sie als Parameter syncScopeId den Key für den Synchronisationsbereich, den Sie von uns erhalten. Mit den optionalen Parametern from und to können Sie Datenabfragen in Bezug auf das letzte Änderungsdatum des Datensatzes einschränken.

Der Button "Try it out!" startet die Abfrage.

Dem Feld Request URL können Sie die URL für den Aufruf der Anfrage entnehmen.

Im Feld Response Body finden Sie im Abschnitt "createdOrUpdate" die nodeIdPart aller zur Verfügung stehenden Objekte.
Im Abschnitt "removed" finden Sie Entitäten, die nicht mehr in der Datenbank enthalten sind.

Dem Feld Response Code sind ggf. Fehlermeldungen zu fehlgeschlagenen Anfragen entnehmen.

Das Feld Response Header enthält den Header der Anfrage.

Schnittstelle GET /search/resources/{nodeIdPart}

Mit der Schnittstelle GET /search/resources/{nodeIdPart} können Sie alle Objekte mit allen Propertys abrufen. Übergeben Sie hierzu die mit der Schnittstelle GET /ext-sync/get-updated-nodes alles nodeIdPart einzeln als Parameter im Feld nodeIdPart .

Die Beschreibung der einzelnen Parameter finden Sie hinter dem Eingabefeld des Parameters.

Schnittstelle GET /crawl

Die Schnittstelle GET /crawl liefert direkt alle Daten eines Datensatzes inklusive der mit dem Datensatz verknüpften Datensätze und deren Eigenschaften. Dabei werden die Ergebnisse in standardmäßig in Paketen zu je 25 Datensätzen bereitgestellt. 

Im Abschnitt _meta des Ergebnisses des Crawls werden die Parameter crawlId und nextID bereitgestellt. Die Werte dieser Parameter sind in der Schnittstelle zu übergeben um die nächsten Datenpakte abzurufen. Der Parameter furtherReceivableNodes gibt Auskunft darüber, wie viele Datensätze noch abzurufen sind. 

Die Bedeutung an der anderen Schnittstellenfelder ist in der Anwendung dokumentiert. Um die Systemperfomance nicht negativ zu beeinflussen, bitten wir die den Wert des Feldes batchSize nicht zu verändern.