現在、APIの利用がどんどん多くなり、APIを利用するには、それを呼び出す方法を理解する必要がよくあります。本文では、APIを呼び出す方法を詳しく紹介するので、初心者の方々でも、API呼び出し方がすぐわかると思います。
APIの呼び出しについて
現在、APIの汎用に伴って、APIの使い方を知る必要がある場合も多くなります。APIの利用の中、一番重要なことは、APIの呼び出しになります。APIの呼び出しは、時にはAPIのリクエスト、APIのコールとも言われています。APIの呼び出しは、クライアントからデータをサーバーに送信することを指しています。
APIを正しく呼び出すと、サーバーから意図した通りの正確なレスポンスが返されます。例えば、ユーザー情報を取得するAPIの場合:
- APIのエンドポイント(URL)を確認する
- メソッド(GET、POSTなど)を確認する
- 必要なパラメータ(ユーザーIDなど)をリクエストに含める
- 認証(APIキーなど)が必要な場合は設定する
これらを正しく設定してAPIを呼び出すと、そのユーザーの情報がJSON形式などでレスポンスとして返ってきます。レスポンスを確認する時に、ステータスコードが成功(200番台)か失敗(400番台)かをチェックするのが大切です。また、API呼び出しにエラーが発生する場合、どのエラーが発生しているか、どのような対処をすべきなのかを判明するために、エラーハンドリングもしっかり実装する必要があります。
API呼び出し方の確認：API仕様書
それでは、どのエンドポイントにどのようなHTTPメソッドを使用して、APIを呼び出すのかを知るために、各APIの仕様書でこれらの情報を確認する必要があります。
API呼び出し方の確認例：Notion API
それでは、ここでNotion APIのページ取得APIの仕様書を例にとって、どのようにAPI仕様書からAPI呼び出し方を確認する方法を皆さんに紹介します。
エンドポイントの確認
一番先に確認すべきなのは、APIのエンドポイントです。APIのエンドポイント(endpoint)とは、APIを利用するためにアクセスするURI(Uniform Resource Identifier)のことを指します。エンドポイントは通常、プロトコル、ドメイン、パスパラメータから構成されます。例えば、Notionのページ取得APIのエンドポイントは、https://api.notion.com/v1/pages/{page_id}になります。
ここでプロトコルは、httpsになり、ドメインはapi.notion.comになり、パスパラメータは/v1/pages/{page_id}になりますね。
HTTPメソッドの確認
APIを呼び出す時、HTTPメソッドも非常に重要です。違う操作を行うために、適切なHTTPメソッドを選択する必要があります。
- GET（コンテンツを取得）
- POST（コンテンツを新規追加）
- PUT（既存コンテンツを変更）
- DELETE（コンテンツを削除）
必須のパラメータの確認
どのようなメソッドを使ってどこに送信することを確認した以上、何かを送信するかを確認する必要があります。
同じくNotionのページ取得APIを例にとる場合、「PATH PARAMS（パスパラメータ）」、「QUERY PARAMS（クエリパラメータ）」、「HEADERS（ヘッダー）」が必要です。それに、「QUERY PARAMS（クエリパラメータ）」に「required（必須）」が付いていないので、それを記入しなくても良いことを意味します。
パスパラメータは、すでにエンドポイントのURLに記入されているので、ここでHEADERS（ヘッダー）を記入して送信すると、正確なレスポンスを取得できるはずですね。
API認証の確認
また、多くのAPIは、アクセス制御やセキュリティを確保するための認証と認可の仕組みを提供します。これにより、APIを利用するためにユーザーが認証情報を提供したり、アクセス権限を持っているかどうかを確認したりします。OAuth、トークンベースの認証などが一般的な認証の手法です。
認証が必要となるAPIの場合、API KeyやAPIトークンなどの取得方法は、それぞれの公式ドキュメントで確認する必要があります。
APIクライアントでAPIを呼び出す方法
上記のようにそれぞれのAPI仕様書でAPI呼び出しに必要な情報を確認した上、一番簡単なAPI呼び出し方は、APIクライアントを使うことになります。そこで、この部分では、非常に直感的で使えるAPIクライアントのApidogを使って、APIの呼び出し方を詳しく皆さんに紹介します。
ステップ⒈Apidogを開き、「新しいRequest」を選択して、リクエストを新規に作成します。
ステップ⒉同じくNotionのページ取得APIを例にとって、HTTPメソッドをGETにして、エンドポイントのhttps://api.notion.com/v1/pages/{page_id}を入力します。
ステップ⒊このAPIの仕様書に記載されているように、HEADERS（ヘッダー）に「Notion-Version」を記入して、送信ボタンをクリックして、APIを呼び出して、レスポンスを取得できるようになります。
以上は、API管理ツールのApidogを使用して、簡単にAPIを呼び出す方法になります。他のAPIを呼び出したい場合でも、基本的にはAPI仕様書で呼び出しに必要な情報を手に入れて、APIクライアントを使用して、それぞれの情報を記入して送信するという流れになります。
複数のAPIを一括に呼び出す方法
また、特に大きなプロジェクトの中、複数のAPIを一括に呼び出す必要がたまにあります。複数のAPIの一括呼び出しも、ApidogというAPIクライアントによって簡単に実現できます。
Apidogの自動テスト機能を使って、異なるHTTPリクエストが何個あっても同時に一括送信することもできます。
ステップ⒈左側のメニューから「自動テスト」を選択して、「テストのシナリオを新規作成」して、「ステップを追加」をクリックすると、API呼び出しをテストステップとして追加することができます。
ステップ⒉このモジュールでは、ステップ数の上限がないので、呼び出したいAPIが何個あっても、ここに追加することができます。APIの呼び出しの追加が完了した後、「実行」ボタンをクリックして、各APIを追加順に従って呼び出すことができます。
そして、「往復回数」を設定すると、全てのステップが繰り返して実行されるので、非常に便利です。
