店舗スタッフアカウントのインポート – Shopらんサポートサイト

店舗スタッフの登録・更新を行えます。
アカウントデータを CSV ファイルで作成し、WebAPI でアップロードします。

呼び出し先URL

{your-domain} の部分をご利用環境に合わせて変更してください。

https://{your-domain}/h2/STRStaffAccountManipurator.do

リクエスト

パラメータ名	意味	必須	制約・説明
`func`	動作モード	〇	必ず `importCsv` を指定します。
`key`	WebAPIキー	〇	アカウント管理APIが利用可能な WebAPIキーを指定します。
`csv`	CSVファイル	〇	店舗スタッフ情報の CSV ファイルを指定します。
`importMode`	一括操作のインポートモード		以下の値を指定できます。 `add` : 現在存在しない店舗スタッフを追加する `modify` : 既存の店舗スタッフ情報を更新する `disable` : CSV に存在しない店舗スタッフを無効にする
`passwordExpirationFlag`	次回ログイン時のパスワード更新		`1` または `0` を指定します。 `1` : パスワードを更新した店舗スタッフの次回ログイン時に、パスワード更新を強制する `0` : 強制しない
`force`	エラーを無視してインポートを実施するか		`1` または `0` を指定します。 `1` : エラーとなったデータを無視して、なるべくインポートを実施しようと試みます。

補足事項

CSVファイルは 店舗スタッフの管理＞一括インポート＞エクスポート からダウンロードできます。
importMode を省略した場合は、すべてのモードを指定したもの とみなされます。
つまり、CSV に存在する店舗スタッフは追加・更新され、CSV に存在しない既存の店舗スタッフは無効になります。
複数の importMode を指定する場合は、同一パラメータ名を列挙 して値を変えて指定してください。
force=1 の場合、レスポンスの info にエラー内容が出力され、error-lines にエラーのあった行番号が出力されます。
force のデフォルトは 0 です。

HTMLによるリクエストサンプル

インポートモードに「追加」と「更新」を指定する場合の例です。

<form method="POST"
    enctype="multipart/form-data">
    :
    <input type="hidden" name="importMode" value="add" />
    <input type="hidden" name="importMode" value="modify" />
    :
</form>

レスポンス

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="info" type="xsd:string" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="error-lines" type="xsd:string" minOccurs="0" maxOccurs="1" />
    </xsd:sequence>
  </xsd:element>
</xsd:schema>

レスポンス要素

要素	意味	備考
`//response/result`	リザルトコード	`1` : 成功 `4` : 入力パラメータの内容にエラーがある `8` : その他のシステムエラーが発生
`//response/errors`	エラーメッセージ	エラーが発生した場合、詳細なエラーメッセージが文字列で返されます。
`//response/info`	更新ログ	店舗スタッフアカウントを更新したログが文字列で出力されます。
`//response/error-lines`	エラーを無視した行番号	`force=1` を指定したとき、エラーがあった行の行番号をカンマ区切りで返します。

アカウント更新に成功した場合のレスポンスXML例

<response>
  <result>1</result>
  <info><![CDATA[
    * 1: Modifying an existing account STF0000100001.
    * 2: Adding a new account STF0000100007.
  ]]></info>
</response>

説明

//response/result が 1 のため、呼び出しは成功です。
//response/info には、更新・追加された店舗スタッフのスタッフコードが返されます。
例では、STF0000100001 は既存の店舗スタッフ更新、STF0000100007 は新規追加を表します。

CSVファイルの仕様

店舗スタッフ情報の CSV ファイル仕様は以下の通りです。

〇 : 必須
△ : 追加時は必須

列名	必須	桁数	内容
`id`	〇	120	スタッフコードを指定します。
`password`	△	120	平文のパスワードを指定できます。既存アカウント更新時に空欄にした場合は、既存のパスワードを変更しません。
`md5Password`		120	GNU版 `crypt(3)` で生成される $1$ から始まる MD5 ハッシュのパスワードを指定できます。`password` 列とどちらかを指定します。
`name`	△	240	名前を指定します。
`phoneticName`	△	240	ふりがなを指定します。
`mail`		240	メールアドレス
`mobileMail`		240	モバイルメール
`sortOrder`	△	3	ソート順位
`enable`		5	有効フラグ。`TRUE` または `FALSE` を指定できます。
`openDate`		10	有効期間の開始日
`closeDate`		10	有効期間の終了日
`store0～`		480	所属する店舗の店舗コードを指定します。FC法人機能を使用しているときは、法人コードを指定することもできます。複数店舗に所属している場合には、`store0`、`store1` と列を追加して指定してください。

`store0～` の補足

店長として所属している時
店舗コードの後ろに、スペース区切りで #1 を付与します。
副店長として所属している時
店舗コードの後ろに、スペース区切りで #2 を付与します。

文字コード

本サービスでアップロードする CSV ファイルの文字コードについては、CSVファイルの仕様 を参照してください。