Bearer認証でREST APIジョブのエンドポイントを呼び出してみよう

(1) REST APIジョブのエンドポイントで実行するスクリプトを作成する

このシナリオでは、「CSVを加工するスクリプトを作ってみよう」で作成したスクリプトを使用します。

(2) APIプロジェクトを作成する

• > APIマネジメント > APIプロジェクトを選択します。

• APIプロジェクトページで、追加を選択します。

• APIプロジェクト > 新規追加ページの手順全般で以下のとおり設定し、次へを選択します。

  項目名	設定（例）
  名前	REST_API_job_PJ
  ワークスペース	Personal
  説明	（任意）
  基本パス	api-test

• 手順サマリーで、入力した内容を確認し完了を選択します。

(3) APIプロジェクトにリソースを追加する

• APIプロジェクトページで、リソースアイコンを選択します。

  

• APIプロジェクト > REST_API_job_PJ > リソースページで、 のHTTPメソッドを追加からGETを選択します。

  

• APIプロジェクト > REST_API_job_PJ > リソースページの右レイヤーで、以下のとおり設定し、Applyを選択します

  項目名	設定（例）
  プロジェクト	sample1
  バージョン	最新のバージョン番号を設定する。
  スクリプト	Script
  レスポンス設定
  レスポンスコード	200
  レスポンス本文	テキストJSONdata

  その他の項目の設定は任意です。

(4) APIクライアントの作成

• > APIマネジメント > APIクライアントを選択します。

• APIクライアントページで、APIクライアントを作成を選択します。

• APIクライアント > 新規追加ページの手順全般で以下のとおり設定し、次へを選択します。

  項目名	設定（例）
  名前	API_Client
  説明	（任意）
  メンバー	メンバーのリストからエンドポイントを呼び出すユーザーを選択します（複数可）。
  IP許可リスト	（任意）

• 手順サマリーで、入力した内容を確認し完了を選択します。

(5) REST APIジョブの作成

• > ジョブ > REST APIジョブを選択します。

• REST APIジョブページで、追加を選択します。

• REST APIジョブ > 新規追加ページの手順全般で以下のとおり設定し、次へを選択します。

  項目名	設定（例）
  ワークスペース	Personal
  APIプロジェクト	REST_API_job_PJ
  APIプロジェクトバージョン	最新のバージョン番号を設定する。
  プロファイル	プロファイルを選択する。
  説明	（任意）

• 手順API設定で、以下のとおり設定し、次へ選択します。

  項目名	設定（例）
  APIクライアント	API_Client

• 手順スクリプト実行のためのサービスで、以下のとおり設定し、次へ選択します。

  項目名	設定（例）
  スクリプト実行のためのサービス	実行中のHULFT Integrateサービス名を設定する。

• 手順サマリーで、入力した内容を確認し完了を選択します。

  エンドポイントが自動で作成されます。

• REST APIジョブページで、情報アイコンを選択します。

• REST APIジョブ > REST_API_job_PJページでエンドポイントのURLをコピーし、メモ帳などのテキストエディターに控えておきます。

  コピーしたエンドポイントのURLは手順2. 2  で使用します。

2. 1 アクセストークンを更新する

アクセストークンには有効期限があります。有効期限が切れている場合は、REST APIジョブのエンドポイントにリクエストを送信する前にアクセストークンを更新します。

アクセストークンの有効期限はデフォルトで60分です。Admin権限で最大1日にすることができます。

HULFT Squareの個人設定 > アクセストークンから取得したリフレッシュトークンを使用して、アクセストークンを更新します。

PUT /v1/rest-api-token

https://app.square.hulft.com/v1/rest-api-token

Authorization: Bearer <Login APIで取得したアクセストークン>

BodyにはJSON形式でリフレッシュトークンを指定します。

{
    "refreshToken":"yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy" （*）
}

{
    "expires": 1669798184,
    "accessToken":"ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ",
    "refreshToken":"yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
    expiresIn: 3600,
    tokenType: "Bearer",
    status: "Valid",
    updated: 1669794
}

2. 2 REST APIジョブのエンドポイントをお客様のHTTPクライアントから実行する

HULFT Squareの > ジョブ > REST APIジョブで作成したHTTPメソッドおよびURLをお客様環境のHTTPクライアントから呼び出します。

https://<お客様のドメイン名>.square.hulft.com/<プロファイル名>/<基本パス>/<リソースパス>

Authorization: Bearer <accessToken>  （*）

3. 実行結果を確認する

正常にリクエストが実行された場合は、HTTPコードに"200 (OK)"の値が返されます。

400、401エラーなど 400番台のエラーが発生した場合には、エンドポイント、アクセストークン、およびリクエストボディなどのリクエスト情報に正しい値が設定されていることを確認してください。また、403の場合には、APIクライアントの設定をご確認ください。

スクリプトの実行結果は、 > サービス > HULFT Integrateのページで確認します。

HULFT Integrateページでは、以下のとおり、フィルタを追加でフィルターをかけて確認できます。

• レスポンスボディにexecution_idが出力された場合

  実行IDにexecution_idを指定して確認してください。

• レスポンスボディにexecution_idが出力されなかった場合

  プロジェクト名またはスクリプト名を指定して、開始日時などの時間を目安に実行結果を特定し確認してください。