6.2 API利用時の認証
APIのリクエストを発行してレスポンスを得るには，リクエストのたびにJP1ユーザーによる認証が必要です。認証は，JP1/Baseのユーザー認証機能を使用します。
認証を受けるには，リクエストを発行するときに，リクエストヘッダーに「X-AJS-Authorization」を指定して，JP1ユーザー名とパスワードを送信します。リクエストを受けたマネージャーホストの認証サーバ（JP1/Base）で，指定されたJP1ユーザー名とパスワードの認証が行われます。JP1ユーザー名またはパスワードを指定しなかった場合，または誤っていた場合は，認証が必要なことを示すステータスコード「401」が返却されます。リクエストヘッダーおよびリクエストの形式については，「6.4 リクエストの形式」を参照してください。
リクエストヘッダーに記述する認証情報の形式を次に示します。
X-AJS-Authorization:userName:passwordをBase64エンコードで符号化した文字列
リクエストヘッダー「X-AJS-Authorization」に指定するパラメーターを次の表に示します。
|
パラメーター名 |
説明 |
必須・任意 |
|---|---|---|
|
userName |
JP1ユーザー名を文字列で指定します。 JP1ユーザーは，あらかじめログイン先のJP1/AJS3 - Managerが使用する認証サーバに登録されている必要があります。 JP1ユーザー名に指定できる文字の詳細については，マニュアル「JP1/Base 運用ガイド」のユーザー管理の設定について記載している個所を参照してください。 |
必須 |
|
password |
JP1ユーザーのパスワードを文字列で指定します。 パスワードに指定できる文字の詳細については，マニュアル「JP1/Base 運用ガイド」のユーザー管理の設定について記載している個所を参照してください。 |
必須 |
- 指定例
-
ユーザー名「user」パスワード「password」の場合は，user:passwordをBase64エンコードで符号化して，次の値を指定します。
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==