「ショートカット」で最初の API をリクエストする
最初の API をリクエストするため、通信先にしたい API「エンドポイント」を指す URL を作成してから、その URL を「URL の内容を取得」アクションに渡します。ショートカットを実行すると、このアクションが API リクエストを実行します。
API リクエストを構築する
Dark Sky の Forecast エンドポイントでは、URL リクエストが次の形式になっている必要があります:
https://api.darksky.net/forecast/[YOUR_SECRET_KEY]/[LAT],[LONG]
角かっこ内のテキストには、API キーおよび予報データの対象になる場所を指定します。
「ショートカット」App で、Dark Sky から入手した API キーを最初の「テキスト」アクションに配置します。これは、「URL」アクションに変数として渡されます。
LAT
およびLONG
値はすでに37.8267
および-122.4233
に設定されています。これはサンフランシスコのアルカトラズ島の座標です。(これらの値は別の位置座標に変更できます。)「現在地を取得」アクションを使用し、その値を「URL」アクションの緯度と経度に設定されたマジック変数として配置すると、ショートカットを実行したときの現地の天気データを取得できます。
「URL の内容を取得」アクションで API リクエストを実行する
「ショートカット」App のショートカットエディタで、「URL の内容を取得」を「詳細」に設定します。
実行できる API リクエストの種類では次のオプションを使用できます:
GET
は、API から読み取るデータを取得できます。POST
は、新規データを作成できます。PUT
およびPATCH
は、それぞれ置換または変更によってデータをアップデートできます。DELETE
は、URL リクエストで指定されたオブジェクトを削除できます。
この例では、
GET
リクエストを使用して Dark Sky API からデータを取得します。「URL」アクションにリクエストが含まれ、「URL の内容を取得」アクションはデータの取得(
GET
)に設定されたので、これで API リクエストを実行する準備ができました。注記:「URL の内容を取得」アクションを
POST
、PUT
、またはPATCH
に切り替えると、「本文を要求」という新しいパラメータが追加されます。「本文を要求」を使用すると、リクエストの一部として JSON、フォーム、またはファイルを API に送信できます。新しいデータを手動で入力することも変数を使用して入力することもでき、API にデータを送信してエントリーを作成、置換、または変更することができます。をタップしてショートカットをテストします(ショートカットの「クイックルック」アクションでは、API が返すデータをプレビューできます)。
おめでとうございます。「ショートカット」を使用して最初の API リクエストを実行しました。
まず目につくのは、API が蘷妙なフォーマットのテキストを大量に返しているようにみえることです。よく見てみると、そのテキストには天気予報の情報が含まれていることが分かります。この天気データは JSON でエンコードされています。JSON は JavaScript Object Notation の意味です。
JSON の詳しい操作方法について、および Dark Sky API の例を使い続ける方法については、「ショートカット」での JSON の使用についてを参照してください。