REST の前提条件

Interact API を呼び出す方法の 1 つに、HTTP を介した JSON (JavaScript™ Object Notation) 形式の呼び出しを使用する方法があります。ここでは、REST API と呼びます。 REST API の利点として、SOAP よりパフォーマンスが高いという点がありますが、Interact API 呼び出しで最も早い方法は、Java™ 直列化アダプターを使用する方法です。

REST API の使用を開始する前に、以下の点について知っておいてください。

Interact API の REST 呼び出しをサポートしている URL は、次のとおりです。

http://Interact_Runtime_Server:PORT/interact/servlet/RestServlet。Interact ランタイム・サーバーの実際のホスト名または IP アドレス、および Interact が配置されているポートで置き換えます。

REST API に固有の 2 つの Interact クラスがあります。 1 つは RestClientConnector で、JSON 形式の REST 経由で Interact ランタイム・インスタンスに接続するためのヘルパーの役割を果たします。もう 1 つは RestFieldConstants で、API 要求および応答で使用される JSON メッセージの基本となる形式を説明します。

サンプル REST クライアントが Interact _Home/samples/javaApi/InteractRestClient.java で提供されています。サンプル・コードは単純な例ですが、REST API の使い方を示すための適切な開始点になるはずです。

REST API クラスおよびその他のすべての Interact API 情報について詳しくは、ランタイム・サーバー上にインストールされている Javadoc を参照してください (Interact_Home/docs/apiJavaDoc)。

ここで言及されている情報以外に、REST API では、Interact API を使用するための他のプロトコルによってサポートされるすべての方法がサポートされています。