IM-FormaDesigner for Accel Platform プログラミングガイド 第13版 2018-04-01

12.4. 認証設定を行う

Web APIを実行するには、intra-mart Accel Platform の認証を通過する必要があります。
ここでは、以下3つの認証方法について説明します。
  • Basic認証
  • OAuth認証
  • Cookie認証

注意

認証ユーザと案件の処理を実行するユーザは、それぞれ異なるアカウントが指定可能です。

12.4.1. Basic認証

Web APIを実行するユーザのアカウント情報を利用し、Basic認証の形式でエンコーディングした情報をHTTPリクエストヘッダーで送信します。
全ての案件処理を管理者ユーザのアカウントで行う場合には、この認証方法を利用します。
以下は、リクエスト情報の例です。
  1. Basic認証の形式(アカウントのユーザコード:アカウントのパスワード)の文字列を作成します。
    • (例)ueda:ueda
  2. Base64でエンコードします。
    • (例)YW95YWdpOmFveWFnaQ==
  3. エンコーディングした文字列をリクエストヘッダーとして送信します。
    • (例)Authorization: Basic YW95YWdpOmFveWFnaQ==

注意

Basic認証を利用する場合は、Web APIのURLの前に/basicを付与する必要があります。
  • (例)/basic/api/forma/imw/apply

注意

Basic認証を利用する場合は、盗聴や改竄の危険性があるため、SSLを有効にしてください。

12.4.2. OAuth認証

intra-mart Accel Platform で提供されているOAuth2の認証フローに従いアクセストークンを取得し、HTTPリクエストヘッダーで送信します。
  1. OAuth認証を利用するためのクライアントアプリケーションを intra-mart Accel Platform に登録します。
  2. OAuth2の認証フローに従い、アクセストークンを取得します。
  3. アクセストークンをリクエストヘッダーとして送信します。
    • (例)Authorization: Bearer 718fedeab471477fa1c0deef626e0b0d

注意

OAuth認証を利用する場合は、Web APIのURLの前に/oauthを付与する必要があります。
  • (例)/oauth/api/forma/imw/apply

注意

OAuth認証を利用する場合には、下記のモジュールを構成に含める必要があります。
  • IM-FormaDesigner ワークフロー案件処理Web APIにてOAuth認証を利用する場合

    • IM-FormaDesigner OAuth認証モジュール
  • IM-BIS ワークフロー案件処理Web APIにてOAuth認証を利用する場合

    • IM-BIS OAuth認証モジュール

12.4.4. 認証状態の維持について

Web APIを実行する際に、後続のリクエスト時に認証セッションを維持するかどうかを制御するためのHTTPリクエストヘッダ X-Intramart-Sessionが提供されています。
詳細については、「 Web API Maker プログラミングガイド 」の「 セッション管理 」を参照してください。
HTTPリクエストヘッダ X-Intramart-Session
keep 認証状態 (セッション) を維持します。 API 実行後もログアウトしません (デフォルト)。
once API 実行前に未認証だった場合のみ、 API 実行後にログアウトします。
never 認証状態 (セッション) を破棄して、常にログアウトします。