Power Automate for DesktopからAPIをたたいてみよう！！！

REST APIを利用するには、JSONデータをやり取りする上でいくつか下記のように必要な情報があります。

必要な情報は、利用するAPIのドキュメントに記載されているはずです。利用する前に必ずAPIドキュメントを読んで下記の必要な情報を集めていきます。

「Webサービスを呼び出します」アクションを使ってHTTP/HTTPSを送信します。

PADでREST APIをたたくには、「Webサービスを呼び出します」アクションを使います。このアクションは「HTTP」グループの中にあるアクションです。

下表は、よく使う入力パラメータです。

下表は、実行後に生成され結果が格納される変数です。

詳細は、リファレンスを参照してください。

Power Automate for DesktopでREST APIをたたくには「HTTP」グループの中の「Webサービスを呼び出します」アクションを使います。

「JSONをカスタムオブジェクトに変換」アクションを使ってデータを取り出しやすくします。

「Webサービスを呼び出します」アクションを実行するとPADにJSONが返却されます。

PADの場合、受け取ったJSONは「JSONをカスタムオブジェクトに変換」アクションを使ってオブジェクト型に変換するのが一般的かと思います。なぜかというと、PADは受け取ったJSONをただの文字列のカタマリとしてか認識してくれないため、このままでは扱いづらいのです。オブジェクト型に変換することで後続のアクションで扱いやすくなります。

たとえば下記のサンプルJSONから苗字を取り出す場合を例に考えてみます。PADにとってはJSONはただの文字列ですので、JSONの中から「文字列切り出し」アクションと「文字列検索」アクションを組み合わせて、苗字の” 山田”の前後にある余分な文字列を切り取る必要があります。これは結構面倒です。

ところがオブジェクト型に変換すれば、後続のアクションの中で%JSONのサンプル[“苗字”]%と指定するだけで簡単に苗字を取り出すことが可能です。

{
  "名前": "太郎",
  "苗字": "山田",
  "好きな食べ物": [ "ラーメン","ハンバーガー" ],
  "登録日": "2021/12/01"
}

じょじお

このため、APIから受け取ったJSONはカスタムオブジェクト型に変換しましょう。

Power Automate for DesktopでJSONをオブジェクト型に変換するには「変数」グループの中の「JSONをカスタムオブジェクトに変換」アクションを使用します。

それでは、前置きが長くなってしまいましたがPower Automate for Desktopを使ってWeb APIをたたいてみたいと思います。今回は練習として『すぐ呼び出し可能なWebAPI』というサービスを利用させていただきました。

『すぐ呼び出し可能なWebAPI』は、テストや学習を目的とした方を対象に有志の方が公開してくださっているREST APIです。通常、多くのAPIはユーザ登録をして認証キーを取得する必要とすることが多いのですが、こちらのAPIはユーザ登録不要で無料で利用することができます。

『すぐ呼び出し可能なWebAPI』
https://www.umayadia.com/Note/Note028WebAPISample.htm

このサービスは架空の人物名簿で、人物を取得したり、追加、更新、削除ができます。プログラムの練習やお試しに使用することを想定しています。

引用：すぐ呼び出し可能なWebAPIのサンプル – 概要 https://www.umayadia.com/Note/Note028WebAPISample.htm

APIを利用する際は、必ずドキュメントに記載された利用条件を読み、条件の範囲で節度を持って利用するようにしましょう！

こちらのAPIには下記のようないくつかの機能があるようです。今回はこのAPIの機能の一つGET Personsという機能を使って、こちらのサービスに登録された全人物の一覧を取得することをゴールとします。（図の赤枠の機能）

GET personsという機能を利用する前にドキュメントを確認してみましょう。

先の説明で、REST APIを利用するには6つの必要な情報（エンドポイント・メソッド・ヘッダー・ボディ・送信コンテンツタイプ・受信コンテンツタイプ）があるとお伝えしました。これら6つの情報をAPIドキュメントから探します。

すぐ呼び出し可能なWebAPIのサンプル – ドキュメント

▲上図の情報から、下記のような情報が必要であることがわかりました。

新規フローを作成して「Webサービスを呼び出します」アクションを追加します。追加したら先ほど集めた「APIに必要な情報」を図のように入力しましょう。

返却されたJSONは、「JSONをカスタムオブジェクト」アクションを使って扱いやすくします。

JSONの項目に「%WebServiceResponse%」を渡します。

フローを実行します。

▲フローを実行したらフロー変数の中の「StatusCode」変数を確認します。200番は成功を表すステータスコードですので無事にAPIを実行できたということになります。エラーが起きた場合は、それ以外の数字が入っているはずです。ステータスコードの意味はAPIによって異なりますのでAPIドキュメントを確認して対処してください。

▲正常なステータスコードが確認できたら、返却されたJSONを確認します。フロー変数の中の「JsonAsCustomObject」変数をダブルクリックして中身を確認します。

▲dataのところにある「詳細表示」をクリックします。

▲アイテムの一覧の中に、今回のゴールである「登録されている全人物の一覧」が取得できたことが確認できました！

こちらのJSONには、name（人物名）、note（人物についての一言）、age、registerDateなどがあるようです。受け取るJSONの仕様はAPIによって異なります。こちらも必ずAPIドキュメントで確認するようにしましょう。