ポストマン

私たちのAPIはどんなHTTPクライアントでも使えます！私たちは ポストマンこれは、強力なクロスプラットフォームHTTPクライアントへのフレンドリーなグラフィカル・インターフェースである。

Postmanで実行 "ボタンをクリックすると、最もよく使われているAPIをクイックスタートできます：

ベータ版または開発者プレビュー版APIが必要な場合は、APIリファレンスページにあるOpenAPIドキュメントをPostmanで使用する方法をお読みください。

ポストマンとOpenAPI

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

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

APIのOpenAPI説明を取得する

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

スペックをPostmanにインポートする

Postmanを起動し、左側のバーの上にある「インポート」ボタンを探してください。ブラウズして .yml 使用したいファイルを選択し、"Open"、"Next "の順に選択する。

左側のサイドバーに、API用のフォルダ/コレクションができ、その中にAPIの各エンドポイント用のテンプレート・リクエストができる。

APIコールを行う

例えば、Verify APIの説明をインポートした場合、左側のバーから "Verify Request "を選択し、すぐに使えるリクエストを得ることができる。必要なフィールドを追加してください：

• API認証情報！Verify APIの場合は、以下のようになります。 API_KEY そして API_SECRET フィールドの詳細は、アカウントダッシュボードで確認できます。
• Verifyする電話番号（E.164形式を使用してください。）
• Verifyを行うブランド名（ここではテストするだけなので、何を選んでもよい）
• を設定する。 format パスパラメータセクションの json

ここで "Send "を押し、APIからのレスポンスを確認する。

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

私たちはポストマンの大ファンなので、私たちの最高のヒントをここで紹介しようと思った。

使用環境

ポストマンは 環境機能 これは、同じ変数（API認証情報など）をさまざまなリクエストで使用する場合に便利です。

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

• api_key
• api_secret
• phone_number

値を保存し、リクエストでAPIキーを貼り付ける代わりに、次のように入力します。 {{api_key}} で、Postmanは現在の環境の値を使う。

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

ポストマンコレクション

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