この記事の概要

Wrikeの中の人が配布したPostmanのコレクションをつかってWrikeのAPIを試してみる。
この公式コレクションは2020年の10月配布なのでそれ以降に追加されたAPIは含まれていません。

参照

WrikeのAPI Refferenceはこちら

WrikeのWebinar（元記事英語）はこちら

前提条件

Postman用のCollectionファイル、Environmentファイルをダウンロードしておく。

https://cdn.wrike.com/CSO/Official_Wrike_Collection.zip
https://cdn.wrike.com/CSO/Wrike_Postman_environment.zip

手順

Wrike側は今回永続トークンを使うので下記の通り

①Postmanをインストール
②PostmanへCollection、Environmentをインポート
③Wrike側でAPI使用の許可＆永続トークンを発行する
④Postmanの環境設定に永続トークンを設定し、設定する。
⑤WrikeのAPIを叩いてみる。
Appendix コレクションの汎用化

となります。

①Postmanをインストール

Postmanのインストールは本家Webサイトからか、Macの場合はHomebrewからのインストール。

% brew install postman

その後はPostmanのアカウント作ってください

②PostmanへCollection、Environmentをインポート

ダウンロードしたZipファイルを回答するとjsonファイルになります。こちらをPostmanへインポートします。

Official Wrike Collection v 1.0.postman_collection.json
Wrike.postman_environment.json

My Workspaceの右側にあるImportをクリックします
ダウンロードした2ファイルをドラッグアンドドロップします。
Importをクリックします。
左のWorkspaceにコレクションが、右上の方にEnvironmentがインポートされます。コレクションは公開されているAPIをメソッド化したようなもの、Environmentは環境変数をまとめたものになります。

③Wrike側でAPI使用の許可＆永続トークンを発行する

Wrikeの右上にある自分のアイコンをクリックし、『アプリ＆統合』をクリック
左ペインにあるAPIをクリックし、アプリ名に任意の名前を入力し『新規作成』をクリック
画面下部の方へスクロールし、トークンを作成をクリック
Wrikeのパスワードを入力し、トークンの取得をクリック
コピートークンをクリック（このトークンは一度しか表示されないのでご注意ください）。Wrike側から削除しない限り永続的に使用できます。

④Postmanの環境設定に永続トークンを設定し、設定する。

③で取得した永続トークンをPostmanのEnvironmentへ設定し、コレクションから使用できるようにします。

右上の環境設定ドロップダウンリストからWrikeを選択し、設定アイコン（目玉）をクリックしEditをクリックします。
WRIKE_TOKEN項目のINITIAL VALUEとCURRENT VALUEに永続トークンを入力し（前後のスペースに注意）、VARIABLEのWRIKE_API_URLの名前をWrikeAPI(Collection側の変数名と違うため)へ変更し、Saveをクリックします。
コレクション側の設定を確認します。コレクション『Official Wrike Collection v 1.0』をクリックし、Authorizationをクリックします。

TypeがBearer Token
EnvironmentがWrike
Tokenが{{WRIKE_TOKEN}} 　←　オレンジ色

になっていればOKです。

⑤WrikeのAPIを叩いてみる。

あとはCollection内のMethodを叩いて見るだけです。GETメソッドであればデータを持ってくるだけなので安全です。

Contacts以下にある、Get Information about meをクリックしてSendをクリック。

下段にあるコンソール部分にOutputがJson形式で表示されれば設定はOKです。

Appendix：コレクションの汎用化

配布されているコレクションなどはIDをクエリのパラメーターとして使用しているものが多いです。

とりあえずTask一覧が出したいというクエリを発行するには既存のコレクションを右クリックしDuplicateし、新たにGet Taskのようなものを作成、クエリの項目を下記のように変更（ID部分を削除、Fieldはチェック外す）しSendすればOKです。

{{WrikeAPI}}/tasks/

こんなかんじです。

あとはSendすればOKです。

Fieldパラメーターはこちらはレスポンスの項目でOptionalになっている項目をクエリしたいときに必要です。

TasksのResponse例

詳しくはAPI Referrenceを見てください。

より高度にAPIを使うにはプログラム実行環境やクエリしたデータのパース、キャスト（型変換）が必要になってきますが、どういったデータをWrikeから取得できるのか？というテストはPostmanを使うと非常に簡単に行えます。

WrikeではWrike Integrateというアドオンを契約することにより、サーバ構築、ジョブ設定といった実行環境を必要としない他SAASとの連携が可能となっております。

下記もご参照ください

Postman&Wrike公式配布コレクションをつかい永続トークンを使用して、WrikeのAPIを叩いてみる。