新しいAPIリファレンスが追加されました

今回は、少し前に公開された新しいAPIリファレンスをご紹介します。

SendGridでは、ほぼ全ての機能をAPI経由で利用することができます。これまで、APIリファレンスはドキュメントページにて公開していましたが、これに加えて開発者向けにより使いやすい新しいAPIリファレンスの提供を開始しました。新しいAPIリファレンスを利用することで、開発やトラブルシューティングがより一層行いやすくなります。新しいAPIリファレンスでは、各エンドポイントをブラウザ上からコールすることができるので、実際にコードを書く前に、リクエストとレスポンスの内容を確認できます。それでは簡単にご紹介します。

エンドポイントの検索

新しいAPIリファレンスでは、キーワードでエンドポイントを簡単に検索できます。画面左上のテキストボックスにキーワードを入れると関連するエンドポイントが動的に絞り込まれ、候補を表示してくれるので、簡単にお目当てのエンドポイントを探し出すことができます。

エンドポイントの検索

各エンドポイントの詳細の確認

お目当てのエンドポイントが見つかったら、選択して詳細を確認してみましょう。各エンドポイントのリクエストパラメータやレスポンスの定義は画面右側に表示されています。現在は英語版のみの提供となっているため、日本語訳が必要な場合は、既存のAPIリファレンスをご覧ください(基本的な内容は既存のAPIリファレンスの内容と同じです)。

各エンドポイントの詳細の確認

ブラウザから実際にリクエストを送ってみる

それでは、実際にブラウザからリクエストを送ってレスポンスを確認してみましょう。

  1. 画面右側の「Try it out」タブを選択します。
  2. 必要なパーミッションを与えたAPIキーを生成し、「YOUR_API_KEY」に貼り付けます。
  3. Request Body」でリクエスト内容を編集します。
  4. 最後に「SEND REQUEST」ボタンを選択してリクエストを送信します。
  5. リクエストを送信すると、「SEND REQUEST」ボタンの下の「Response」にレスポンス内容が表示されます。エラーが発生した場合は、レスポンスでエラー内容が確認できます。

ブラウザから実際にリクエストを送ってみる

レスポンスの確認

サンプルコードを生成する

リクエストを送信後、「Response」の下側に「Code Generation」という枠が表示されます。ここでは、CurlやC#、Java、Node.js、Pythonなど様々なプログラミング言語やクライアント向けのサンプルコードが確認できます。これを参考に実際のコードを実装していくことができます。

サンプルコードを生成する

いかがでしたか?新しいAPIリファレンスは使い方が簡単で、パッとAPIの挙動を試してみる、とりあえず動くサンプルコードを生成する、といった用途で威力を発揮するのではないかと思います。現在は英語版のみの提供となっていますが、今後は日本語版の提供も予定していますので、是非ご期待ください!