制限事項

会員APIを利用する際は下記制限事項が適用されます。

1. 各会員APIの実行処理結果を待たずに連続して会員情報の登録・更新・削除を行った場合の会員情報の整合性は保障されません。
2. 会員情報取得APIを利用して会員のパスワードを取得することはできません。
3. 会員情報に機種依存文字が含まれる場合の文字コード変換時の文字化けについては保障されません。
4. 会員情報削除APIを利用して会員情報削除を行う場合、ショップの設定や会員の注文情報の状態により会員情報の削除を行えない場合があります。

前提条件

会員APIを利用するためには以下の条件を満たす必要があります。

1. 会員データ連携機能の利用制限が解除されている必要があります。
2. 会員データ連携設定画面で認証コードを発行、設定を保存している必要があります。
3. HTTPSプロトコル（SSL）を使用して通信を行います。SNIにご対応ください。

ご利用前の準備

会員データ連携設定画面で会員APIを利用するための設定を行います。

会員データ連携機能の設定

1. 会員データ連携設定メニュー
   • 会員データ連携設定画面に遷移します。
2. 認証コード
   • 発行ボタン押下でアクセスURL発行時に利用する、新しい認証コードを発行し、入力不可のテキスト領域に認証コードを表示します。
   • 保存ボタンが押下されるまでは発行した認証コードを保存しません。
     • 一度も保存を行っていない場合は、認証を行えないため、会員APIの各機能を利用できません。
   • 認証コードの登録の有無により発行ボタンの文言が切り替わります。
     • 認証コードが保存されていない場合は「発行」を表示。
     • 認証コードが保存されている場合は「再発行」を表示。
3. 利用する会員APIの設定
   • 会員APIの各機能の利用を許可するかを設定します。
     • 会員情報参照・・・会員情報取得APIの利用可否を設定します。
     • 会員情報登録・・・会員情報登録APIの利用可否を設定します。
     • 会員情報変更・・・会員情報更新APIの利用可否を設定します。
     • 会員情報削除・・・会員情報削除APIの利用可否を設定します。
   • 「許可しない」を選択して設定を保存すると該当機能が利用できなくなります。
   • 初期値は全て「利用する」
4. 保存ボタン
   • 上記で設定された会員データ連携の設定を保存します。
   • 認証コードが発行されていない状態では設定を保存することができません。
   • 認証コードが未発行の状態では会員APIの各機能を利用できません。

会員API利用時の処理フロー

下記が会員API利用時の概略図です。

会員API共通仕様

会員APIでは以下の共通の仕様があります。

• レスポンスの応答形式はXML形式とJSON形式から選択できます。
• レスポンスの応答形式が未指定の場合はXML形式を適用します。
• パラメータ送信時の文字コードはUTF-8を利用してください。
• 会員APIを利用するための前提条件を満たしていない場合はHEADERレスポンスのみを返却します。
• 会員APIに送信するパラメータ値にはURLエンコードを行ってください。
• レスポンスの応答形式がXMLの場合、会員APIからURLエンコードを行った値を返却するため、レスポンス取得時にURLデコードを行ってください。
• 各APIにアクセスする為のURLはアクセスURL発行APIを実行し、取得してください。
• アクセスURL発行APIの実行結果より取得したURLに対し、POSTメソッドでパラメータを送信してください。

処理結果として返却するステータスコードには以下の種類があります。

• エラーメッセージ（※）の内容は変更になる可能性があるため、ステータスコードで処理結果を判定してください。
• 各APIアクセス時の必須パラメータ項目が設定されていない場合は、不正アクセスと見なし応答を返却しません。
• ショップの機能制限設定が解除されていない場合は、不正アクセスと見なし応答を返却しません。

XML形式のサンプルレスポンス

<?xml version="1.0" encoding="utf-8"?>
<result_data>
    <status_code>200</status_code>
    <access_token>85fabea79e90eb2b8cf51c326899252c</access_token>
    <expire_date>20130913235959</expire_date>
    <total_count>100</total_count>
    <display_record_from>1</display_record_from>
    <display_record_to>100</display_record_to>
    <member_list>
        <member>
            <group_id/>
            <member_id>usertest</member_id>
        </member>
    </member_list>
    <member_id>usertest2</member_id>
    <error_message/>
</result_data>

JSON形式のサンプルレスポンス

{"result_data":{"status_code":"200","total_count":0,"display_record_from":null,"display_record_to":null,"member_list":null,"error_message":null}}

アクセスURL発行APIの仕様

• 会員データ連携機能設定画面で発行した認証コードと呼び出す機能を指定し、各会員APIにアクセスするためのURLを発行する機能です。
• アクセスURL発行APIには下記URLに対して、POSTメソッドでパラメータを送信してください。

リクエストURL

https://www.makeshop.jp/api/member/auth/

返却されたアクセスURLの例

https://www.makeshop.jp/api/member/search/?shop_id=flowershop2015&access_token=7efc686ff0e9d79eff72cefc4bc1f563

送信パラメータ

• ○：必須項目

戻りパラメータ

• ○：機能を利用できる場合、必ず返却する。
• △：項目パラメータのキー値は必ず返却するが、条件により値が空になる。
• ※1 送信パラメータを利用した認証に成功した場合、返却する。（認証エラーが発生した場合は空の値を返却）
• ※2 送信パラメータによる認証時にエラーが発生した場合、返却する。

会員情報取得API

会員情報を検索する機能です。

• ソート順が未指定の場合は会員登録日の昇順でソートした結果を返却します。
• 会員情報取得API実行で一度に返却可能な会員情報の件数は100件です。
• 100件を超える会員情報の一覧を取得する場合は表示ページを指定してください。

送信パラメータ

• ○：必須項目

戻りパラメータ

• ○：機能を利用できる場合、必ず返却する。
• △：項目パラメータのキー値は必ず返却するが、条件により値が空になる。
• ※1 検索結果に該当する会員情報が存在する場合に返却する。
• ※2 送信パラメータの入力チェックでエラーが発生した場合、返却する。

会員情報登録API

新規に会員情報を登録する機能です。

• 会員情報登録API実行で一度に登録できる会員情報は1件です。
• 送信パラメータの値が空の状態の場合、該当する会員情報の項目にはデフォルト値が設定されます。
• 登録時にショップポイントを付与することはできません。

送信パラメータ

• ○：必須項目
• △：条件付き必須項目 リクエストで送信されていない項目値は登録しない。
• ※1 会員ID自動採番設定がNの場合必須となる。
• ※2 基本登録項目の設定で必須に設定されている場合は必須となる。
• ※3 都道府県リストに存在する都道府県を都道府県文字列に指定している場合は都道府県コードを都道府県リストから取得して自動で設定する。
• ※4 追加入力項目の設定で必須に設定されている場合は必須となる。|は入力できない。

戻りパラメータ

• ○：機能を利用できる場合、必ず返却する。
• △：項目パラメータのキー値は必ず返却するが、条件により値が空になる。
• ※1 会員情報の登録に成功した場合に返却する。
• ※2 送信パラメータの入力チェックでエラーが発生した場合、返却する。

会員情報更新API

登録済みの会員情報を更新する機能です。

• 会員情報更新API実行で一度に更新できる会員情報は1件です。
• 更新を行う会員情報の項目のみ、送信パラメータのキーを送信してください。
  • 送信パラメータの値が空の状態の場合、該当する会員情報の項目は空白になります。

送信パラメータ

• ○：必須項目
• △：更新を行う項目のみリクエストを送信する。リクエストで送信されていない項目値は更新しない。設定済み項目値を削除したい場合は、空の値を送信する。
• ※1 基本登録項目の設定で必須に設定されている場合は必須となるため、項目値の削除はできない。
• ※2 メールアドレス認証設定にYを指定しメールアドレスの変更を行う場合は変更後のメールアドレスが他の会員によって利用されていない必要がある。
• ※3 都道府県リストに存在する都道府県を都道府県文字列に指定している場合は、都道府県コードを都道府県リストから取得して自動で設定する。
• ※4 追加入力項目の設定で必須に設定されている場合は必須となるため、項目値の削除はできない。|は入力できない。
• ※5 「ショップポイント変動理由」は「ショップポイント」と同時指定が必須。単独での更新は不可。「ショップポイント」更新時に「ショップポイント変動理由」の入力がない場合は固定文字列「管理者によるポイント更新」をショップポイント変動理由ログに入力する。

戻りパラメータ

• ○：機能を利用できる場合、必ず返却する。
• △：項目パラメータのキー値は必ず返却するが、条件により値が空になる。
• ※1　会員情報の更新に成功した場合に返却する。
• ※2　送信パラメータの入力チェックでエラーが発生した場合、返却する。

会員情報削除API

登録済みの会員情報を削除する機能です。

• 会員情報削除API実行で一度に削除できる会員情報は1件です。
• 予約販売の注文情報が存在する会員情報は削除できません。
• 定期購入の注文情報が存在する会員情報は削除できません。
• 多店舗連携を行っているショップの会員は削除会員となります。
• 商品購入時に決済会社に保存した会員のカード情報は削除します。

送信パラメータ

• ○：必須項目

戻りパラメータ

• ○：機能を利用できる場合、必ず返却する。
• △：項目パラメータのキー値は必ず返却するが、条件により値が空になる。
• ※1 会員情報の削除に成功した場合に返却する。
• ※2 送信パラメータの入力チェックでエラーが発生した場合に返却する。

都道府県リスト

各種パラメーターで指定される都道府県リストは、以下の番号に対応しています。

会員API企画書社外用.pptx
会員API別紙パラメータ一覧.xlsx