Skip to main content

Postman の使用方法

Postmanを使用してServer API V3のテストを行うことができます。

必要条件:

  • Postman がインストールされている必要があります。Postman は go.postman.co/home で入手できます。

  • Postman で Server API をテストするには、API キーと API シークレットが必要です。詳細については、 ユーザーロールと権限 のヘルプページを参照してください。

Postman に API を追加

Server API をテストするには、Postman へのインポートを行います。

  • まず、Server API V3 のインポートに使用するリンクを取得する必要があります。このリンクを検索するには、Server UI に移動し、右上の「?」アイコンを選択し、[ API ドキュメント ] を選択します。API V3 Swagger ページが表示されます。

  • Swagger ページにある API ドキュメントのアドレスを確認します。

    Note the address of the API documentation you find on the Swagger page. 

  1. Postman の [ コレクション ] にアクセスし、[ インポート ] を選択します。

  2. [ Link ] を選択し、 ステップ 2 で確認したServer API URL を入力して [ 続行 ] を選択します。

  3. これで [ コレクション ] タブに Alteryx Server API V3 が表示されます。

認証の設定

リクエストを送信できるようにするには、Postman で認証を設定する必要があります。

  • [ コレクション ] にアクセスし、[ Alteryx Server API V3 ] を選択します。

  • [ 認証 ] タブで、タイプとして [ OAuth 2.0 ] を選択します。

  • 現在のトークン を次のように設定します。

    AD273A073BE2399E360B94B3F9EB79C6.png

  1. 「 Configure New Token 」セクションで、次の設定を行います。

    1. 必要に応じて [ トークン名 ] を入力します。

    2. [ Grant Type ] で [ Client Credentials ] を選択します。

    3. [ アクセストークン URL ] に、認証サーバーのエンドポイントを入力します。エンドポイントを探すには、Swagger にアクセスし、 トークン URL を検索します。詳細については、 API の設定および認証 ヘルプページの「 認証方法 」セクションを参照してください。Server API の設定と認証

      Find the Token URL in Swagger.

      最終的なトークンの設定例:

      How the API authorization looks like in Postman.

    4. [ クライアント ID ] に、Server UI の [マイプロファイル] 下にある API アクセスキー を入力します。

    5. [ クライアントシークレット ] に、Server UI の [マイプロファイル] 下にある API シークレットキー を入力します。

    6. [ Client Authentication ] で、[ Send as Basic Auth header ] を選択します。

  2. [ Get New Access Token ] を選択します。

Environment の設定

Environment にも同じ値の設定が必要です。

  1. 右上にある、目のアイコンを選択し、[ Add for Environment ] を選択します。

  2. Environment 名を入力します。

  3. 「認証の設定」セクションの ステップ 4 で行ったのと同じ baseUrl、API キー、API シークレットを入力します。

  4. 使用している Environment の URL を入力してください。これは、 Alteryx システム設定 内で ベースアドレス として存在するものです。「認証の設定」セクションの ステップ 4 を参照してください。

  5. [保存] を選択します。

リクエストの送信

Postman では Server API をテストできます。また、リクエストの承認、送信の他、リクエストのさまざまなコードタイプを調べたりすることができます。

例

ユーザーが所有するアセットのリストを取得したいとしましょう。

  1. まずは、ユーザー ID を知る必要があります。

    1. [ コレクション ] にアクセスし、 Alteryx Server API V3 を選択します。

    2. [ ユーザー ] を選択し、[ GET Search for User records ] を選択します。

    3. [ params ] タブでは、パラメーターを使用してすべてのユーザーレコードを検索できます。

    4. リクエストを送信するには [ 送信 ] を選択します。入力したパラメーターに基づいて結果が表示されます。

    5. 結果で、アセットのリストを取得したいユーザーの ID をコピーします。

  2. 別のタブで別のリクエストを開きます。[ ユーザー ] にアクセスし、[ id ] を選択します。

  3. [ GET Retrieve a full list of assets that a user owns ] を選択します。前回のリクエストで取得したユーザー ID を入力し、このユーザーのアセットのリストを取得します。

EF76F0DE8E6C3302DC8217A5E26730F2.png

注記

Postman 経由でリクエストを送信するときは、認証する必要があります。リクエストを認証するには、次の 2 つのオプションがあります。

  • [ タイプ ] で [ OAuth2 ] を選択し、使用可能なトークンを 1 つ選択します。

  • [ タイプ ] で、[ Inherit auth from parent ] を選択します。コレクション全体に対して設定した認証が使用されます。

このセクションの内容: