基本事項 – 初めてのAPIコール

APIの基本からAPIコールを行うまで


アプリにぴったりなAPIを見つける

まず最初のステップは、使いたいAPIを検索することです。今回は例としてSMS系のAPIを検索してみましょう。

alt text


検索ボックスに「SMS」と入力し、「検索」をクリックしてください。

alt text

検索結果の一覧から、欲しい機能を持つAPIを選びましょう。人気度、平均レイテンシ、平均正常稼働率などが表示されていますので、API選びの参考にしてください。また、APIにカーソルを合わせると人気のエンドポイントや料金体系(有料・無料・フリーミアム)も確認できます。今回は、試しにTelesign SMS Verify APIを選んでみます。

APIに接続する

使いたいAPIを選ぶと、APIのエンドポイントのページが表示されます。APIの利用に必要なほとんどの情報はこのページに載っています。ナビゲーションバー、利用可能なエンドポイントの一覧、各エンドポイントの説明文、そしてコードスニペットが表示されています。スニペットは8言語で用意されており、コード作業の手間を省くことができます。

alt text

APIのページでは、ナビゲーションバーに料金プランのタブがあるかどうかを最初に確認してください。料金プランページがあれば、そのAPIはリクエストを行う前にプランへのサブスクリプション登録が必要になります。

APIの料金プランの種類や請求の仕組みについては、こちらをご確認ください。

プランに登録する

料金が設定されているAPIを利用する場合、まずはご登録されるプランをお選びください。プランごとに月額料金と、割当量を超過して利用した場合に適用される超過料金が設定されています。

alt text

無料のBASICプランが設定されているAPIも多数あります。このプランを使えば、設定されている割当量以内であればAPIを無料でお試しいただけます。プランの利用制限の確認・承諾はお客様の責任となりますので、ご注意ください。

プランの割当制限にご注意ください:

プランの割当制限と自分の使用量を把握しておくことはとても重要です。上限を超えて利用した分については超過料金が請求されます。

APIのテスト

プランへのサブスクリプションが完了したら、「エンドポイント」のタブに戻りましょう。このページで、試したいエンドポイントのパラメータを入力し、ブラウザで直接エンドポイントをテストすることができます。「テスト」ボタンをクリックするとAPIへのリクエストを行うことができ、レスポンスもブラウザ上ですぐに確認できます。

alt text
  
検証結果に問題がなく、自分のアプリをAPIに接続するときは、「コードスニペット」タブに切り替えてください。お使いのプログラミング言語を選択して、スニペットをアプリに挿入すれば完了です。リクエストライブラリを使用する際に便利なインストールガイドもご活用ください。

alt text