Voraussetzungen für REST

Eine Methode des Aufrufs der Interact-API besteht darin, Aufrufe im JSON-Format (JavaScript™ Object Notation) über HTTP zu verwenden. Dies wird im vorliegenden Dokument als REST-API bezeichnet. Die REST-API bietet gegenüber SOAP eine höhere Leistung, obwohl der Java™-Serialisierungsadapter immer noch die schnellste Methode für Interact-API-Aufrufe ist.

Bevor Sie die REST-API verwenden, müssen Sie Folgendes bedenken:

Die URL, die REST-Aufrufe an die Interact-API unterstützt, lautet:

http://Interact-Laufzeitserver:PORT/interact/servlet/RestServlet, wobei in dem Pfad der tatsächliche Hostname oder die IP-Adresse des Interact-Laufzeitservers und der Port, auf dem Interact bereitgestellt wird, angegeben werden müssen.

Es gibt zwei Interact-Klassen, die spezifisch für die REST-API sind: RestClientConnector, die als Hilfsprogramm dient, um die Verbindung zu einer Interact-Laufzeitinstanz über REST mit dem JSON-Format herzustellen, und RestFieldConstants, die das zugrunde liegende Format der JSON-Nachricht beschreibt, die für API-Anforderungen und -Antworten verwendet wird.

Ein REST-Beispielclient wird unter Interact _Home/samples/javaApi/InteractRestClient.java bereitgestellt. Auch wenn es sich nur um einen einfachen Beispielcode handelt, sollte er ein geeigneter Einstieg sein, um die Verwendung der REST-API zu demonstrieren.

Eine vollständige Beschreibung der REST-API-Klassen zusammen mit allen anderen Informationen zur Interact-API finden Sie im auf dem Laufzeitserver installierten JavaDoc unter Interact_Home/docs/apiJavaDoc.

Zusätzlich zu den hier genannten Informationen unterstützt die REST-API alle Methoden, die von den anderen Protokollen zur Verwendung der Interact-API unterstützt werden.