Yield Analytics API での Postman の使用

[アーティクル]
02/26/2024

概要

このチュートリアルの目的は、新しい Postman をインストールし、パブリック Yield Analytics API で使用可能なすべての API 呼び出し用のテンプレートを使用することです。これにより、API 呼び出しの定型パラメーターを繰り返し構築することなく、特定のクライアントデータに合わせて API 呼び出しの基礎を調整できます。チュートリアルの終わりまでに、次を介して API と対話するための強固な基盤が必要です。

Yield Analytics パブリック API 内のすべての API 呼び出しのテンプレート
クライアントのニーズに合わせてテンプレート呼び出しを抽象化できるようにする環境変数
特定の顧客の作業環境
作業中の特定の通話をエクスポートして共有する方法
http 呼び出しを cURL などの他の形式に変換する方法の基本的な理解

Yield Analytics API サービスの Swagger テンプレート

Postman への Swagger テンプレートのインポート

Swagger テンプレート URL をコピーするには、アドレスをコピーするか、をクリックして、上記の目的のテンプレートから URL をコピーします。
[Postman] で[ファイル→インポート] を選択します。
[リンクからインポート] を選択し、テンプレート URL を貼り付けます。
ヘッダーには、標準キーと {{}} でラップされた値があることに注意してください。これらはそのままにして、次のセクションに進みます。

変数を使用した Postman 環境の設定

Postman では、{{}} でラップされたテキストは変数として扱われます。変数は、さまざまな値を取ることができるシンボルです。以前のプログラミングエクスペリエンスの他の言語の変数に精通している可能性があります。 Postman の変数も同じように動作します。
Postman では、環境の概念もサポートされています。これは基本的に、操作する目的のクライアントの作業グループに変換する変数のコレクションです。
次の図は、{{client_url}}、{{accepts}}、{{username}}、{{password}}、{{source}} の各変数を示しています。
環境をセットアップするには、現在アクティブな API 呼び出しの上にある歯車アイコンをクリックし、[環境の管理] を選択します。
次に、[追加] ボタンをクリックし、環境に名前を付け、次の図に示すように値を含む変数名を追加します。
最後に、[環境] ドロップダウンから新しい環境を選択します
API 呼び出しが呼び出されると、{{}} の変数は実行時に変数に割り当てた値に置き換えられます。

注:

テンプレートは API 呼び出しの開発を高速化することを目的としており、クライアントに適用可能なデータを使用して URL と本文のパラメーターが調整されるまでは機能しない可能性が非常に高いです。

Postman からの API 呼び出しのエクスポート

Postman には、作業を共有するための複数のメカニズムが用意されています。エクスポートを使用すると、作業中の API 呼び出しをすばやく簡単に共有できます。このプロセスでは、呼び出しに追加したすべてのパラメーターを含む.json ファイルがダウンロードされます。この.json ファイルは、前に説明したインポートプロセスを使用して別のユーザーによってインポートできます。唯一の違いは、リンクではなくファイルからインポートすることです。

注:

エクスポートする前に、パスワードをクリアする必要があります。
ここでのメインの目標は、知識の共有と、呼び出しが正しくないか、サーバーアクションが正しくないかどうかを迅速に判断するために使用できる実行可能な例をエンジニアリングに提供することです。

https 呼び出しを cURL コマンドに変換する

Postman では、これらの HTTPS API 呼び出しを他の形式にすばやく簡単に変換できます。アクティブな API 呼び出しの右側にある [コード] リンクをクリックし、次の図に示すように目的の変換を選択するだけです。

Postman で http 呼び出しを cURL コマンドに変換する方法を示すスクリーンショット。

次の方法で共有