Skip to main content

Postman の使用方法

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

必要条件:

  • Postman がインストールされている必要があります。Postmanは https://www.postman.com/downloads/ から入手できます。インストールしてアカウントを作成します。ブラウザ版ではなく、デスクトップ版のPostmanを使用してください。メールアドレスの確認ができていても、ブラウザ版を使用している可能性があります。

    注記

    PostmanのWeb版は、APIがファイアウォールの内側にあるため、ほとんどのお客様のAPIにアクセスできません。そのため、PostmanのWeb版では到達できません。

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

Postman に API を追加

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

ドキュメントURLとトークンURLの取得

  1. ドキュメントURLを取得するには、Server UIに移動し、右上隅の「 ? 」アイコンを選択し、[ APIドキュメント ] を選択します。API V3 Swagger ページが表示されます。

    api_postman_getdetails0.png

  2. ドキュメントURL を取得します。「webapi」の後ろに2つのバックスラッシュが付いていることに注意してください。

    注記

    ローカルホスト指定は、Postmanと同じホストでServerが実行されている場合にのみ機能します。それ以外の場合(リモートワークステーションの場合)は、localhostの代わりにホスト名もしくはIPアドレスを使用する必要があります。

    api_address_docu.png

    例: http://localhost/webapi//swagger/docs/3

  3. 任意のAPIエンドポイントを表示します。

  4. 右側の 赤い感嘆符(!) を選択して、認証プロセスを開始します。

  5. トークンURLをコピーします。例: http://localhost/webapi/oauth2/token

    api_copy_tokenURL.png

PostmanへのSwaggerドキュメントのロード

  1. Postmanで コレクション タブに移動します。

  2. [インポート] を選択します。

  3. ドキュメントURLとトークンURLの取得 の説明に従って、ドキュメントのURLを入力します。

  4. [インポート] を選択します。

    api_swagger_load_01.png
    api_swagger_load_02.png

    これにより、左側の [コレクション] タブに Alteryx Server API V3 が追加されます。

API呼び出しで使用するOAuth2アクセストークンの作成

リクエストを送信できるようにするには、Postmanで認証を設定し、OAuth2アクセストークンを作成する必要があります。

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

  2. [ 認証 ] タブを選択します。

  3. [ タイプ ] で [ OAuth 2.0 ] を選択します。

    api_postman_auth.png

  4. [認証] ページを下にスクロールして、[ 新しいトークンを設定する ] セクションに移動します。

  5. [トークン名] に 任意のトークン名 を設定します。

    注記

    「任意のトークン名」にあたる入力は提供されません。お好きな トークン名 を入力できます。

  6. [ 付与タイプ ] で [ クライアントの資格情報 ] を選択します。

  7. [ アクセストークンURL ] に 上で見つかったトークンのURL を設定します。

  8. [ クライアントID ] に 使用するAPIアクセスキー を設定します。

  9. [ クライアントシークレット ] に 使用するAPIアクセスシークレット を設定します。

  10. [ クライアント認証 ] で [ 基本認証ヘッダーとして送信 ] を選択します。

  11. [ 新しいアクセストークンを取得する ] ボタンを選択します。

  12. [ 続行 ] を選択します。

  13. [ トークンを使用 ] ボタンを選択します。

    api_postman_auth2.png

有効期限が切れた場合のアクセストークンの再作成

一定期間が経過すると元のトークンが期限切れになり、APIにアクセスすると401認証失敗エラーが表示されます。トークンを再度作成するには以下を実行します。

  1. [ コレクション ] タブで、 Alteryx Server API V3 を選択します。

  2. [ 使用できるトークン ] ドロップダウンメニューから [ トークンの管理 ] を選択します。

  3. 期限切れのトークンを選択します(横線が引かれています)。

  4. 期限切れのトークンを削除します。

  5. API呼び出しで使用するOAuth2アクセストークンの作成 の説明に従って、新しいトークンを作成します。

PostmanでのAPIの使用

次の例は、以下のような一般的なAPIのパターンを示しています。

次の例では、APIを使用してServerのユーザーリストからユーザーIDを取得します。次に、そのユーザーIDを使用してユーザーの詳細情報を取得します。最後のステップでは、ユーザーのデータを使用してユーザーレコードを更新します。

簡単のために、この例ではユーザーの名前を変更します。実際には、Server UIを使用してこれを行うのが最善です。

ステップ1: ユーザーのリストからUserIDを取得する

api_postman_search1.png
api_postman_search2.png
api_postman_search3.png

  1. [ Get v3/Users ] に移動します。

  2. 8つの クエリパラメーター すべての選択を解除します(ユーザーコレクションを検索するには、1つ以上のパラメーターを選択して検索値を入力します)。

  3. [ 認証 ] タブを選択します。

  4. [ タイプ ] を OAuth 2.0 に設定します。

  5. 上記で作成したトークンを選択します。

  6. [ 送信 ] を選択します。

  7. 画面の下部に結果が表示されます。

  8. 次の手順で使用するUserIDをコピーします。

ステップ2: ユーザーの詳細情報を取得する

上記の例からUserIDを取得するか、Server UIで直接取得します(ユーザーを表示しているときに、URLからコピーします)。

api_postman_getdetails1.png
api_postman_getdetails2.png
api_postman_getdetails3.png

  1. Get v3/Users/{id} エンドポイントに移動します。

  2. IDパラメーター の値として UserID を入力します。

  3. 前の手順と同様に、[ 認証 ] タブでトークンを選択します。

  4. [ 送信 ] を選択します。

  5. 次のステップで使用するため、画面下部の [ 本文 ] セクションからJSONオブジェクト全体(前後の中括弧を含む)をコピーします。

ステップ3: ユーザーのレコードを更新する

前のステップで使用したユーザーの詳細情報(JSONオブジェクト)を取得します。

api_postman_updatedetails1.png
api_postman_updatedetails2.png
api_postman_updatedetails3.png

  1. PUT v3/Users/{id} エンドポイントに移動します。

  2. IDパラメーター の値として UserID を入力します。

  3. [ 認証 ] タブで、前の手順と同様にトークンを選択します。

  4. [ ヘッダー ] タブを選択します。

  5. フォームデータではなくJSONオブジェクトを送信するため、[ コンテンツタイプ ] チェックボックスの選択を解除します。

  6. [ 本文 ] タブを選択します。

  7. RAW を選択します。

  8. JSON を選択します。

  9. ユーザーデータのJSONオブジェクトを貼り付けます。

  10. 変更するデータを編集します。

  11. [ 送信 ] を選択します。

  12. リターンコード200 OKを確認します。

このセクションの内容: