Postmanは、APIのテストや開発に役立つツールとして人気があります。Kore.aiのAPIとの連携をより便利にするために、当社はPostmanコレクションを開発しました。コレクション全体は次の2つのカテゴリに分かれています。

1. ボットビルダー機能に関連するAPI。
2. 管理者コンソールの機能に関連するAPI。

APIのリストおよび使用方法については、こちらを参照してください。

開始

開始するには、以下をダウンロードして、Postmanをインストールします。

• Postmanアプリはこちら
• Kore.ai Postmanコレクションはこちら
• APIスコープの関連付けやJWTトークンの生成については、以下のドキュメントをご覧ください。

Postmanを起動したら、[インポート] をクリックして、Postmanコレクションのパッケージにある2つのJSONファイルを選択します。インポートが完了すると、下図のように、[コレクション] に [Kore.ai公開API] が表示され、[環境] に [PublicAPIEnv] を選択することができるようになります。

環境設定

Postmanは、基本的にキーと値の組み合わせのセットである設定可能な環境を提供します。これにより、複数のリクエストにまたがって参照可能な、よく使用する変数を作成することができます。詳細についてはこちらをご覧ください。事前に設定済みの [PublicAPIEnv] 環境には、コレクションから参照される、包括的でない変数が含まれています。これらの変数を編集して、独自の値に置き換えます。値を編集するには：

• 環境のドロップダウンの横にある小さな目のボタンをクリックして、編集する
• または、編集したい変数の上にカーソルを合わせ、編集アイコンをクリックする。

APIのテスト

コレクションの中から任意のAPIを選択し、APIリクエストを送信して同じテストを行うことができます。  各APIには、詳細な開発者向けドキュメントへのリンクが含まれています。

Postman is a popular tool to help test and develop APIs. To make it more convenient for integration with the Kore.ai APIs, we’ve developed a Postman collection.

The entire collection is divided into two categories:

1. APIs which are related to the Bot Builder functionality;
2. APIs related to the Admin Console functionality.

For the complete list of APIs along with usage instructions, refer here.

Getting Started

To get started, download the following and install Postman.

• Postman App from here
• Kore.ai Postman Collection from here
• Go through the following document for details on API Scope association and JWT token generation.

Once you have Postman running, you can click ‘Import‘ and select the two JSON files in the Postman Collection package. After it has been imported, you should see ‘Kore.ai Public APIs‘ under Collections and also be able to select ‘PublicAPIEnv‘ as the Environment, as shown below:

Environment Configuration

Postman offers a configurable environment which is essentially a set of key-value pairs. It allows you to create commonly used variables that can be referenced across multiple requests. You can read more about it here.

The pre-configured ‘PublicAPIEnv‘ environment contains a non-exhaustive set of variables that are referenced by the collection. Edit and replace these variables with your own values.

To edit the values:

• either click the little eye button next to the environment dropdown and then edit,
• or hover over the variable you want to edit and click the edit icon.

Testing APIs

You can choose any of the APIs in the collection and Send the API request to test the same.  Each API has a link to the developer docs for more details.