![](https://help.apple.com/assets/62867F4BA154561AD42D0C98/62867F4EA154561AD42D0CA7/ja_JP/389e356d55e928d40def9c16d476e5e0.png)
iPhoneまたはiPadの「ショートカット」で最初のAPIをリクエストする
最初のAPIをリクエストするため、通信先にしたいAPI「エンドポイント」を指すURLを作成してから、そのURLを「URLの内容を取得」アクションに渡します。ショートカットを実行すると、このアクションがAPIリクエストを実行します。
![APIリクエスト。APIエンドポイントを指すURLアクション、その次に「URLの内容を取得」アクションが含まれています。](https://help.apple.com/assets/62867F4BA154561AD42D0C98/62867F4EA154561AD42D0CA7/ja_JP/2b8ab06358300f8eda833c11e1d1962c.png)
APIリクエストを構築する
Typicodeのエンドポイントでは、URLリクエストがこの形式になっている必要があります:
https://jsonplaceholder.typicode.com/[リソース]
括弧内のテキストがアクセスするリソースです。Typicodeには、リクエストをテストするさまざまな例が多くあります。この例では、https://jsonplaceholder.typicode.com/users
を使用してユーザのリストをリクエストします。
iOSまたはiPadOSデバイス上の「ショートカット」Appで、URLにリクエストを追加します。
users
リクエストが、ユーザのリストを返します。以下のように特定のユーザをIDで指定すれば、検索を絞り込めます:
https://jsonplaceholder.typicode.com/users/6
。これでIDが6のユーザが返されます。ほとんどのAPIで以下の形式のクエリーを使用できます:
https://jsonplaceholder.typicode.com/users?username=Bret
。「?」でクエリーが開始され、キー/値ペアを使って項目が検索されます。この例では、?username=Bret
のクエリーでユーザ名がBretのユーザが検索されます。サポートされている検索やクエリーについては、APIのマニュアルを確認してください。
「URLの内容を取得」アクションでAPIリクエストを実行する
iOSまたはiPadOSデバイス上の「ショートカット」Appで、「URLの内容を取得」アクションの「さらに表示」をタップします。
実行できるAPIリクエストの種類では次のオプションを使用できます:
GET
は、データを取得できます。POST
は、新規データを作成できます。PUT
は、置換によってデータをアップデートできます。PATCH
は、変更によってデータをアップデートできます。DELETE
は、URLリクエストで指定されたオブジェクトを削除できます。
この例では、
GET
リクエストを使用してTypicode APIからデータを取得します。「URL」アクションにリクエストが含まれ、「URLの内容を取得」アクションはデータの取得(
GET
)に設定されたので、これでAPIリクエストを実行する準備ができました。注記: 「URLの内容を取得」アクションを
POST
、PUT
、またはPATCH
に切り替えると、「本文を要求」という新しいパラメータが追加されます。「本文を要求」を使用すると、リクエストの一部としてJSON、フォーム、またはファイルをAPIに送信できます。新しいデータを手動で入力することも変数を使用して入力することもでき、APIにデータを送信してエントリーを作成、置換、または変更することができます。ショートカットをテストするには、
をタップします。
まず目につくのは、APIが意味不明なテキストを返しているようにみえることです。このデータはJSONでエンコードされています。JSONはJavaScript Object Notationの意味です。
JSONの詳しい操作方法について、およびTypicode APIの例を使い続ける方法については、iPhoneおよびiPadの「ショートカット」のJSON使用の概要を参照してください。