0. はじめに
本記事は下記の３回に分けて Postman を使用した LINE WORKS API のコール方法を書きまーす。
- 第１回 準備編
- 第２回 Server API 編
- 第３回 Service API 編
本記事は、準備編になります。
準備編の流れは下記の通りです。
- こんなの作ります
- まずは、Developer Console の設定
- GitHubからPostmanの設定データをインポート
- Postmanに設定している環境変数の説明と設定
- まとめ
1.こんなの作ります
Postman を使用して、LINE WORKS の Server API と Service API をコールする環境を 準備編 + Server API 編 + Service API 編で作ります。
面倒な Access Token も Postman で取得・保持する方法も載せちゃいます。
※現状は、Postman ですべての API をコールする状態ではありません。Postman の設定情報を更新した際は Export して GitHub の line-works-postman の push して行こうと思っていますので watch していただければ幸いです。（twitterでもつぶやきますので@shotamaco1のフォロー願います）
2.まずは、Developer Console の設定
LINE WORKS API コールに必要な下記のデータを Developer Console の設定を行って取得しておく。
これらのデータを Postman の Enviroment に設定するので重要。
- Domain ID
- API ID
- Service API Consumer Key
- Server API Consumer Key
- Server List（ID登録タイプ）
- ID
- 認証キー
Service API Consumer Key 発行時の設定
いずれすべてのAPIをコールする予定なので、すべての項目をONにする。
Tokenの有効期限は適当でOK。Postmanで簡単にTokenを取得するようにするので。
Server API Consumer Key 発行時の設定
いずれすべてのAPIをコールする予定なので、すべての項目をONにする。（カレンダーの照会はONにできない。。。）
Tokenの有効期限は適当でOK。Postmanで簡単にTokenを取得するようにするので。
3.設定ファイルをPostmanにインポート
GitHub の line-works-postman リポジトリのPostman 設定ファイルをローカルの Postman にインポートします。
LINE WORKS 用の Workspace 作成
まずは Postman に LINE WORKS 用の Workspace を作成します。Workspace 名は適当でOK。
「Create New」をクリック。
「Name」（Workspace名）を適当に入力。「Create Workspace」をクリック。
LINE WORKS 用の Worksplace が作成されました。
GitHubから設定ファイルをダウンロード
GitHub より line-works-postman をクローンまたはダウンロードします。（今回はダウンロードのする方法で説明します）
ダウンロードしたZIPを回答すると下記の構成になっています。
Environment ファイルのインポート
ローカルの Postman に Enviroment ファイルをインポートします。
「Manage Environments」ボタンをクリック。
「Import」ボタンをクリック。
「ファイル選択」ボタンをクリック。
ダウンロードし解答した「Environments/DomainEnv.postman_environment.json」を選択して「開く」をクリック。
DomainEnvが追加されればOK！
Collection ファイルをインポート
ローカルの Postman に Server API と Service API の Collection ファイルをインポートします。
「Import」ボタンをクリック。
「Choose Files」ボタンをクリック。
ダウンロードし解答した「Collections/Server APIs.postman_collection.json」と「Collections/Service APIs.postman_collection.json」を選択して「開く」をクリック。
Server API と Service API の Collection が表示されればOK！
4.Postman 環境変数の説明と定義
Postman の Environment と Collection に Variable （変数）を定義しています。
各変数の値を自分の LINE WORKS の環境の値に変えれば、すぐに API をコールすることができる感じです。
Environment 説明と定義
Environment には、おもに LINE WORKS API を使用する際に必要な Developer Console で発行した情報等を設定するようにしています。
また、Server API、Service API 共通で使用する画像やアカウントIDを登録しています。
Environment は、Domain 単位で定義することにより API のコール先を簡単に切り替えれることを目的に使ってます。
Environment の変数定義の命名規則は、すべて大文字で単語をアンダースコアでつないでます。例えば、DOMAIN_ID、API_ID の用になります。
「Manage Environments」ボタンをクリック。
「DomainEnv」をクリック。
各値を修正して「Update」をクリック。
※ ドメイン名は LINE WORKS にログインする際の @ 以降の文字列です。（ログインIDが sample01@works-qiita の場合 、ドメイン名は works-qiita です）
編集した Environment を選択します。
Collection 説明
Collection には、おもに API 実行結果を変数にセットして、次の API で使用する場合に使用しています。
例えば、Bot 登録 API をコールした結果 Bot No が Response されるのでそれを Postman の Tests で Collection の変数に登録してます。
Collection の変数定義の命名規則は、すべて大文字で単語をアンダースコアでつないでます。例えば、bot_no_01、access_token の用になります。
「Server APIs」の「・・・」をクリックし、「Edit」をクリック。
「Variables」タブをクリック。ここでは特に修正する必要はありません。
※ API コールの結果が登録されるためAPIをコールしていない場合は何も定義されていないかもです。
5. まとめ
以上で準備完了でーす。
Environment の変数は大文字、Collection の変数は小文字にすることによって、Request でどちらの変数を使用しているかをひと目で分かるようにしています。
ここまでくれば、Server API は、上から順番に Request を Send すれば、APIをコールできます。
詳しい使い方は、次回「LINE WORKS API を Postman でコールしてみる（Server API編）」で書きたいと思います。
Service API の方は、Access Token の取得設定をしていない（正確には、Postman に OAuth の設定をしてもエクスポートするすべがない。。。）ので使用できません。
なので「LINE WORKS API を Postman でコールしてみる（Service API編）」で書こうと思います。