Stabile Schnittstellen / APIs
Jede FACT-Finder-Version pflegt die APIs so, dass sie mit den APIs der letzten drei vorherigen Major-Release-Versionen stabil bleiben. Dieses Vorgehen macht FACT-Finder Aktualisierungen für Sie zu einem Kinderspiel. Sie müssen nichts an Ihrem Code ändern, solange die verwendete API-Version noch unterstützt wird. Wenn Sie allerdings neue Möglichkeiten der neuen Versionen verwenden wollen, müssen Sie gegebenfalls Ihre Integration aktualisieren.
JSON / XML
Für die JSON und XML-Schnittstelle ist dieses Feature ab der Version 7.1 verfügbar. Über den URL-Parameter version
lässt sich bestimmen in welcher API-Version die Anfrage beantwortet wird. In der Anwendung ist jedoch auch eine Standard-Rückgabe-Version konfiguriert, so dass der version
-Parameter nicht explizit mitgeschickt werden muss. Im Normalfall ist es am sinnvollsten diesen entsprechend zu setzen bzw. im Projekt setzen zu lassen, eine explizite Übergabe des Parameters kann jedoch zu Test- und Migrationszwecken nützlich sein.
Wenn Sie beispielsweise den Parameter bei der Suchrückgabe verwenden und diese in der API-Version 7.2 erhalten möchten, würde der Aufruf folgendermaßen aussehen:
$stringEscapeUtils.escapeHtml($body)
Die FACT-Finder Version 7.3 unterstützt die Versionen 7.2
, 7.1
, 7.0
und 6.11
. Falls kein gültiger Wert übergeben wird, wird die Antwort in der konfigurierten Standard-Rückgabe-Version geliefert, bei neuen Projekten ist dies im Normallfall 7.2
.
Webservice / SOAP
End of Life
Bitte beachten Sie, dass die SOAP-Schnittstelle nicht mehr erweitert oder aktualisiert wird und mittelfristig entfällt. Wir empfehlen Kunden bei einer Neuintegration diese nicht und stattdessen die REST-API zu verwenden. Sollten Sie bisher die SOAP-Schittstelle verwendet haben, können Sie diese noch weiterhin nutzen, wir empfehlen aber auch hier die Integrationsschnittstelle zu ändern, um von den Vorteilen der anderen Schnittstellen, wie eine schnellere Übertragung und somit Geschwindigkeit, zu profitieren.
Für die SOAP-Schnittstelle ist dieses Verhalten schon länger verfügbar. Hier unterscheidet sich je Schnittstellen-Version, die Sie ansprechen wollen, der Pfad zum Webservice-Endpunkt. Wenn Sie beispielsweise die Webservice-Schnittstellen der Version 7.1 ansprechen wollen, gilt folgender Pfad:
$stringEscapeUtils.escapeHtml($body)
Die FACT-Finder Version 7.3 unterstützt die Endpunkte ws71
, ws70
und ws611
.