ポストマン

当社のAPIはどのHTTPクライアントでも使用できますが、次のことをお勧めします。 ポストマン強力なクロスプラットフォームHTTPクライアントへのフレンドリーなグラフィカル・インターフェース。

VonageはPostmanコレクションを作成し、当社の最もよく使用されるAPIを素早く開始できるように設計しました。ワークスペースは機能別に構成されており、お探しのAPIを簡単に見つけることができます。また、完全に文書化されたリクエストも含まれています。各リクエストの'Description'タブには、そのコールが何をするのか、いつ使うのか、必要な変数（APIキー、シークレット、JWT）、期待されるレスポンスなどを説明する文書があります。

Postmanで実行 "ボタンをクリックして、ワークスペースをあなたのPostman環境にフォークし、コレクションをテストします：

また、以下の手順に従って、OpenAPIの仕様を直接ダウンロードしてインポートすることもできます。

ポストマンとOpenAPI

Postmanは、すべてのAPIで公開しているOpenAPIドキュメントをサポートしています。

Postmanをインストールし、以下の手順に従ってVonage APIのどれでもすぐに試すことができる。私たちは各APIについてOpenAPIドキュメントを公開しており、Postmanはこれらを読み込んで、あなたが値を入力できるリクエストのコレクションを作成することができます。

OpenAPI仕様書のダウンロードとインポート

OpenAPIドキュメントを見つける最も簡単な方法は、試したいAPIのAPIリファレンスにある「Download OpenAPI 3 Specification」ボタンをクリックすることです。例えば APIリファレンスページのVerify をクリックし、ダウンロードボタンをクリックしてください。ダウンロードは .yml または .json という形式をとっている。

その後、次のことができる。 この指示 をクリックしてファイルをPostmanにインポートする。

APIコールを行う

インポートすると、API で利用可能なさまざまなエンドポイントが表示されます。例えば、Verify API の説明をインポートした場合、左側のナビから "Request a verification be sent to a user" を選択すると、すぐに使えるリクエストが表示されます。ヘッダーと本文を必要な情報で更新したら、'Send' を押して API からのレスポンスを確認します。

ポストマンの高度な使い方

使用環境

ポストマンは 環境機能 を使うことで、同じ変数 (API 認証情報など) をさまざまなリクエストで使うことができます。

環境を作成するには、画面右上の設定コグをクリックし、「追加」を選択します。環境に名前を付け、使用したい変数を追加します：

• api_key
• api_secret
• phone_number

保存したら、例えば次のように入力します。 {{api_key}} を、APIキーを貼り付ける代わりにリクエストに追加してください。Postmanは現在の環境の値を使用します。

複数の環境を持つことができます。異なるキーを異なることに使用する場合や、PrismのようなデバッグツールやAPIモッキングサーバーにAPIリクエストを送信する場合に便利です。上記の手順を繰り返し、画面右上のドロップダウンから使用する環境を選択することで、必要な数の環境を追加できます。

ポストマンコレクション

Postmanコレクションについては ポストマンコレクション ドキュメンテーション