APIの認証方式

説明概要

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

認証方式一覧

認証方式 説明
OAuth OAuthとは、APIへのアクセスを認可するためのオープンなプロトコルです。
OAuth 1.0aに対応しています。
OAuthについての詳細は、OAuth.netやRFC 5849を参照してください。
Basic認証 Basic認証とは、HTTPで定義されている認証方式のひとつです。
Basic認証について詳細は、RFC 2617を参照してください。

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を指定することも可能です。

Basic認証

DataSpider BPMのAPIはBasic認証に対応していますが、無認証でアクセスしてもBasic認証が必要であることを示すサーバのレスポンス(WWW-Authenticateヘッダ)は返しません。
Basic認証を使用する場合は、最初のリクエストからAuthorizationヘッダにユーザ名とパスワードの情報を含めてください。

例: この値を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

仕様制限