APIの認証方式

説明概要

DataSpider BPMの提供するAPIを使用して外部のソフトウェアやサービスとの連携を行う場合、原則としてDataSpider BPMのユーザでの「認証」手順が必要となります。
DataSpider BPMの認証方式は以下の3通りの方法を使用することができます。

認証方式一覧

認証方式 説明
Basic認証 HTTPで定義されている認証方式のひとつです。
Basic認証について詳細は、RFC 2617を参照してください。
OAuth OAuth 1.0aに対応しています。
OAuthについての詳細は、OAuth.netやRFC 5849を参照してください。
今後のバージョンで廃止予定
OAuth2 OAuth 2.0に対応しています。
OAuth2についての詳細は、OAuth.netやRFC 6749を参照してください。

Basic認証

1. 設定情報

Basic認証を用いてAPIにアクセスするためには、APIアクセスを有効にする必要があります。

設定する場所 「システム設定」-「接続アプリケーション」-「Basic認証によるAPIアクセス」
設定に関する詳細は、「接続アプリケーション」を参照してください。
その他仕様について
  • Basic認証による通信で使用されたID情報は、システムログに記録されます。
  • 無認証でアクセスしてもBasic認証が必要であることを示すサーバのレスポンス(WWW-Authenticateヘッダ)は返しません。
  • Basic認証を使用する場合は、最初のリクエストからAuthorizationヘッダにユーザIDとパスワードの情報を含めてください。

2. ユーザIDおよびパスワードの設定例

例: この値をBase64でエンコードします。

このユーザアカウントを使用した場合のHTTPリクエストのAuthorizationヘッダは以下のようになります


 GET /userweb/API/PE/Workitem/listAllocated HTTP/1.0
 User-Agent: Wget/1.10.2
 Accept: */*
 Authorization: Basic U2F0b0Bsb2NhbGhvc3QubG9jYWxkb21haW46c3Nzc3Nzc3M=
 Host: test.testserver.com

OAuth

1. クライアントアプリケーションの登録

OAuthを用いてAPIにアクセスするためには、APIにアクセスするクライアントアプリケーションを事前にDataSpider BPMに登録しておく必要があります。

設定する場所 「システム設定」-「接続アプリケーション」-「OAuthを使用する接続アプリケーション」
設定に関する詳細は、「接続アプリケーション」を参照してください。
署名方式 HMAC-SHA1

2. OAuth URL一覧

リクエストトークン <ContextRoot>/OAuth/requestToken
ユーザ認証 <ContextRoot>/OAuth/confirmAccess
アクセストークン <ContextRoot>/OAuth/accessToken
コールバックURL <ContextRoot>/OAuth/authorized

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。
コールバックURLは、DataSpider BPMで提供しているページです。
      OAuthプロトコルのやり取りの間でコールバックURLを指定しなかった場合には、このページが使用されます。他のURLを指定することも可能です。

OAuth2

1. クライアントアプリケーションの登録

OAuth2を用いてAPIにアクセスするためには、APIにアクセスするクライアントアプリケーションを事前にDataSpider BPMに登録しておく必要があります。

設定する場所 「システム設定」-「接続アプリケーション」-「OAuth2クライアント一覧」
設定に関する詳細は、「接続アプリケーション」を参照してください。
グラント種別 Authorization Code

2. クライアントアプリケーション設定情報

名前 登録するクライアントアプリケーションの名前を設定します。
クライアントID DataSpider BPMが自動的に発行します。
クライアントシークレット DataSpider BPMが自動的に発行します。
スコープ APIへのアクセス権の範囲(スコープ)を以下から選択します。
  • any: すべてのAPIへのアクセスを許可(all)
  • read: データを取得するAPIへのアクセスを許可(readonly)
リダイレクトURL 認可リクエスト承認後に、リダイレクトされるクライアントのURLを設定します。
認可エンドポイントURL <ContextRoot>/oauth2/authorize
トークンエンドポイントURL <ContextRoot>/oauth2/token

「<ContextRoot>」は、DataSpider BPMのルートURIである「http(s)://<ホスト名>:<ポート番号>/userweb」を意味します。