本部ユーザーのインポート – Shopらんサポートサイト

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

呼び出し先URL

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

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

リクエスト

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

補足事項

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

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` 指定時に、エラーがあった行番号をカンマ区切りで返します。

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

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

説明

//response/result が 1 のため、呼び出しは成功です。
//response/info には、更新・追加されたアカウントのログインIDが返されます。
例では、00001 は既存アカウントの更新、00007 は新規追加を表します。

アカウント更新に失敗した場合のレスポンス例

<response>
  <result>4</result>
  <errors><![CDATA[
    * 1: Modifying an existing account 00001. * mail is invalid. (00001)
    * 2: Adding a new account 00007. * Specified group is not found. (00007)
    * 3: Adding a new account 00008. * sortOrder is invalid. (00008)
      :
  ]]></errors>
</response>

説明

//response/result が 4 のため、呼び出しは失敗です。
//response/errors にはエラー内容が返されます。
例では以下を示しています。
- 00001 : メールアドレスの指定が不正
- 00007 : 指定した本部グループが存在しない
- 00008 : ソート順位の指定が不正

CSVファイルの仕様

本部ユーザー情報の CSV ファイル仕様は以下の通りです。

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

列名	必須	桁数	内容
`id`	〇	120	ログインIDを指定します。
`password`	△	120	平文のパスワードを指定できます。既存アカウント更新時に空欄の場合は、既存パスワードを変更しません。
`md5Password`		120	GNU版 `crypt(3)` で生成される $1$ から始まる MD5 ハッシュのパスワードを指定できます。`password` 列とどちらかを指定します。
`name`	△	240	名前を指定します。
`phoneticName`	△	240	ふりがなを指定します。
`mail`	△	240	メールアドレス
`mobileMail`		240	モバイルメール
`postalCode1`		3	郵便番号前半
`postalCode2`		4	郵便番号後半
`address1`		240	住所1
`address2`		240	住所2
`telephoneNumber`		120	電話番号
`facimileTelephoneNumber`		120	FAX番号
`sortOrder`	△	3	ソート順位
`enable`		5	有効フラグ。`TRUE` または `FALSE` を指定できます。
`openDate`		10	有効期間の開始日
`closeDate`		10	有効期間の終了日
`group0～`		480	所属する本部グループのグループコードを指定します。
`colors0～`		120	環境の分割機能を使用している場合、ユーザーが所属する区分を指定できます。
`defaultColors`		120	環境の分割機能を使用している場合、マイ設定の表示フィルターで最初に選択される区分を指定できます。

`group0～` の補足

グループコードを設定していない本部グループは変更されません。

インポート前にグループコード未設定の本部グループに所属していた場合
→ 新たに指定した本部グループと、グループコード未設定の本部グループの両方に所属します。
インポート前にグループコード設定済みの本部グループに所属していた場合
→ 新たに指定した本部グループのみに所属します。

文字コード

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

次のAPIも同じ体裁で整形できます。