Configuration requise pour REST

Pour appeler l'API Interact, vous pouvez utiliser des appels au format JSON (JavaScript™ Object Notation) sur HTTP, désignés dans le présent document par le terme API REST. Les performances de l'API REST sont meilleures que celles de SOAP, bien que l'adaptateur de sérialisation Java™ reste la méthode la plus rapide pour appeler l'API Interact.

Avant de vous servir de l'API REST, prenez connaissance des points suivants :

L'adresse URL qui prend en charge les appels REST de l'API Interact est :

http://serveur_exécution_Interact:PORT/interact/servlet/RestServlet, dans laquelle vous devez indiquer l'adresse IP ou le nom d'hôte réel du serveur d'exécution Interact et le port sur lequel Interact est déployé.

Il existe deux classes Interact propres à l'API REST : RestClientConnector, qui sert d'assistant pour la connexion à une instance d'exécution Interact via REST au format JSON, et RestFieldConstants, qui décrit le format sous-jacent du message JSON utilisé pour les demandes et les réponses de l'API.

Un exemple de client REST est fourni dans le répertoire Interact _Home/samples/javaApi/InteractRestClient.java. Cet exemple de code est simple, mais il constitue un bon point de départ pour comprendre comment l'API REST est utilisée.

Pour une description complète des classes de l'API REST et d'autres informations relatives à l'API Interact, consultez la documentation JavaDoc installée sur le serveur d'exécution dans le répertoire Interact_Home/docs/apiJavaDoc.

Enfin, l'API REST prend en charge toutes les méthodes qui sont prises en charge par les autres protocoles pour l'utilisation de l'API Interact.