ユーザーセッションが必要な WebAPI で利用するための セッションキー を生成します。
セッションキーは、生成してから 24時間を過ぎると無効 になります。
呼び出し先URL
{your-domain} の部分をご利用環境に合わせて変更してください。
https://{your-domain}/h2/STRSessionManipurator.doリクエスト
〇: 必須△:loginIdもしくはstoreCode/staffCodeのどちらか必須
| パラメータ名 | 意味 | 必須 | 制約・説明 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず create を指定します。 |
key | WebAPIキー | 〇 | セッション操作APIが利用可能な WebAPIキーを指定します。 |
loginId | 本部ユーザーのログインID | △ | 本部ユーザーのセッションキーを生成するときに指定します。 |
storeCode | 店舗コード | △ | 店舗のセッションキーを生成するときに指定します。 |
staffCode | 店舗スタッフコード | △ | 店舗スタッフ機能を利用している場合、店舗スタッフのセッションキーを生成するときに storeCode と共に指定します。 |
補足事項
- 本部ユーザー、店舗 / 店舗スタッフを同時に指定した場合、本部ユーザーが優先 されます。
- 本部ユーザーが存在しない場合は、店舗 / 店舗スタッフのセッションキー が生成されます。
レスポンス
API の呼び出し結果は、以下のスキーマの XML 文書として返されます。
<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="response">
<xsd:sequence>
<xsd:element name="result" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="session-key" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:element>
</xsd:schema>
レスポンス要素
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 1 : 成功4 : 入力パラメータの内容にエラーがある8 : その他のシステムエラーが発生 |
//response/errors | エラーメッセージ | エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。 |
//response/session-key | セッションキー | 生成されたセッションキーが返されます。セッションキー中の 大文字・小文字は区別 されます。 |
セッション生成に成功した場合のレスポンスXML例
<response>
<result>1</result>
<session-key>718844_1281052521575_ndUaBXsEGsl2HXPk</session-key>
</response>
説明
//response/resultの値が1のため、呼び出しは成功です。//response/session-keyに、生成されたセッションキーが返されます。
セッション生成に失敗した場合のレスポンスXML例
<response>
<result>4</result>
<errors><![CDATA[
* There is no user of 'loginId'.
]]>
</errors>
</response>
説明
//response/resultの値が4のため、呼び出しは失敗です。//response/errorsには、指定した本部ユーザーのログインIDを持つ本部ユーザーが存在しないことを示すエラーメッセージが返されます。