REST Web サービスを使用してアプリケーションで認証する
API キー認証の場合は、認証コードを静的な資格情報プロパティーに入力するか、HTTP ユーザー ID およびパスワードを定義します。入力装置または通知は、認証コード、または HTTP ユーザー ID とパスワードを、データを交換する Web サービスに渡します。次に Web サービスは、アプリケーションで認証を行って応答を返します。
セッション認証の場合は、一連の認証要求プロパティーに、認証資格情報 (ユーザー ID およびパスワード) などの値を入力します。入力装置または通知は、最初に REST Web サービスを呼び出して、アプリケーションで認証を受けます。正常に認証されると、Web サービスはトークンを入力装置または通知に返します。次に入力装置または通知は、データをやり取りするWebサービスに、呼び出し内のトークンを転送します。
- アプリケーションでユーザー 1 人あたり 1 セッションが許可されている場合は、異なるユーザー ID とパスワードで Web サービスを呼び出すように、入力装置と通知をセットアップします。
- セッション認証は、すべての Web サービスの呼び出しで実行され、ログアウトは必要ありません。資格情報の各組み合わせについて、そのセッションの長さが、Web サービス呼び出しの間隔よりも短いことを確認してください。例えば、入力装置のセッションが 10 分後に期限切れになるとします。この場合は、入力装置を構成するときに 10 分よりも長いポーリング間隔を指定します。
アプリケーションの API キーまたは認証資格情報を取得するには、アプリケーションをホストしている会社にお問い合わせください。指定形式と構文の要件については、アプリケーションの資料を参照してください。
- REST Web サービスの入力装置または通知で、認証タブをクリックします。
- アプリケーションで必要な認証タイプの手順に従ってください。
- API キー認証の場合、静的な資格情報プロパティーの値として認証コードを指定します。
その他のプロパティーはすべて空白のままにしておきます。これで手順は完了です。
- セッション認証の場合は、静的な資格情報プロパティーを空白のままにしておきます。次のステップに進み、その他のプロパティーを指定します。
- API キー認証の場合、静的な資格情報プロパティーの値として認証コードを指定します。
- 認証要求 URLプロパティーに、RICOH ProcessDirector がアプリケーションでの認証に使用する URL を設定します。
- 次の1つまたは複数のプロパティーに対してアプリケーションに必要な値を入力して、認証資格情報を指定します。認証要求ペイロード、 認証要求ヘッダー、および 認証要求パラメーター。
- 要求ペイロードプロパティー値には、アプリケーションに送信する認証要求ボディ（存在する場合）を指定します。
これらの例では、ペイロードに次の3つのXMLエレメントが含まれます。<Credentials>、<Name>、および<Password>。<Password>エレメントの値は、 認証要求パスワードプロパティーを使用するシンボルです。
この例では、入力装置のために認証要求パスワードプロパティーを使用しています。
<Credentials> <Name>myname</Name> <Password>${WebService.AuthRequestPwd}</Password></Credentials>
この例では、通知のために認証要求パスワードプロパティーを使用しています。
<Credentials> <Name>myname</Name> <Password>${WSNotification.WebService.AuthRequestPwd}</Password></Credentials>
入力装置または通知は、認証要求を送信するときにシンボルを解決します。
- 要求ヘッダーと 要求パラメータープロパティーの値を必要に応じて設定します。
各ヘッダーフィールドやパラメーターは、キーワードと値のペアです。各ペアは個別の行に指定して、キーワードと値をコロン（:）または等号（=）で区切る必要があります。
キーワードと値は複数の単語にすることができます。RICOH ProcessDirectorは、各行の最初のコロンまたは等号を使用して、語句をキーワードと値のペアに分割します。
これらの例には、nameとpwdという2つのパラメーターが含まれます。pwdキーワードの値は、 認証要求パスワードプロパティーを使用するシンボルです。
この例では、入力装置のために認証要求パスワードプロパティーを使用しています。
name:mynamepwd:${WebService.AuthRequestPwd}
この例では、通知のために認証要求パスワードプロパティーを使用しています。
name:mynamepwd:${WSNotification.WebService.AuthRequestPwd}
このシンボルは、認証要求が送信されるときに解決されます。
- 要求ペイロードプロパティー値には、アプリケーションに送信する認証要求ボディ（存在する場合）を指定します。
- 要求メソッドおよび 要求コンテンツタイププロパティーに、Web サービスで必要な値を設定します。
- 認証応答属性プロパティーに、Web サービスからの応答でセッションの資格情報を識別する XPath 表現を設定します。
- 認証要求パスワードプロパティーに、アプリケーションで使用するアカウントのパスワードを設定します。パスワードは、RICOH ProcessDirector への保存時に暗号化されます。
- 入力装置の場合、このプロパティーはWebService.Credentialです。
- 通知の場合、このプロパティーはWSNotification.WebService.Credentialです。
Web サービスの入力装置または通知に対して要求タブで値を指定する場合は、シンボルとして WebService.Credentialまたは WSNotification.WebService.Credentialプロパティーを指定します。
RICOH ProcessDirector は、要求を Web サービスに転送するときに、シンボルを静的な資格情報またはトークンの値で置き換えます。
- REST Webサービス入力の取得を準備する。
- REST Web サービスへのステータス送信を準備する。