REST API 会員API
最終更新日 2016-4-21

会員を登録する (または SNS 会員の更新)

会員を登録します。または SNS 連携の会員である場合は “更新” にも利用されます。

基本仕様

アピアリーズの会員管理を利用して、アプリにひもづく会員を登録します。

またこの API エンドポイントは SNS 連携会員の場合は「更新」用にも利用されます。
「登録」のときに指定したデータのペイロードから部分的に差異がある場合、
差異のさる内容は create ではなく put/patch されます。

コントロールパネルの会員管理 / 基本設定にて、メールアドレス登録を設定するに設定の場合、
メールアドレス確認の通知が送信されます。メールアドレス確認通知のメールに記載されている
URLをクリックすることで、メールアドレスの確認は完了します(email_verified=trueとなります)。

HTTPメソッド

POST

エンドポイント

/v1/usr/{データストアID}/{アプリID}

リクエスト

トークンには アプリトークンを指定します。指定箇所はヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenに指定します。

ヘッダ

キー 必須 説明 備考
X-APPIARIES-TOKEN △(*1) アプリトークンを指定ください。
Content-Type application/json

クエリ

キー 必須 説明
access_token △(*1)
proc create 省略可能
get 共通仕様参照

(*1)〜X-APPIARIES-TOKENまたはクエリaccess_tokenでいずれか指定。

コンテント

キー 必須 説明 データ型 備考
login_id △(*2) ログインID String
pw △(*2) パスワード String 8文字以上150文字以下. A-Za-z0-9_()*+,-./:;<=>? (半角スペース含む)
email メールアドレス String (*3)
authData △(*2) 認証データ Object SNS連携または匿名認証の場合利用
任意キー 任意の会員属性 String / Number / Boolean / Object (*4)

(*2)〜ID/PW認証の場合はauthDataは指定不要です。SNS連携の場合はauthDataのみ指定。

(*3)〜コントロールパネル、基本設定で メールアドレスの登録許可するに設定の場合、キー( email)の受付が許可されます。また、そのタイミングで、メールアドレス確認通知が送信されます。

(*4)〜任意キーは予約語(共通仕様参照)を除くキーを任意で指定できます。

例) 任意キーの指定例。

成功時レスポンス

リクエスト成功時のレスポンスに関して記述します。エラー時のレスポンスに関しては、 共通エラーレスポンスを参照ください。

ヘッダ

キー名 説明 備考
Content-Type application/json
Location 登録された会員情報を取得するための参照URL

HTTPステータス

ステータスコード 説明
200 SNS連携利用時、ログイン完了
201 会員登録完了

コンテント

会員登録完了時。

キー 必須 説明 データ型 備考
_id ユーザID String 自動生成されるユニークID。
_token ストアトークン String
login_id △(*4) ログインID String
email △(*4) メールアドレス
email_verified △(*4) メールアドレスが確認済みか
任意キー △(*4) 任意属性値 String / Number / Boolean / Object
_cts △(*4) 登録日時タイムスタンプ Number
_uts △(*4) 更新日時タイムスタンプ Number

(*4) 〜 リクエストクエリget=trueを指定の場合返却。ただし、SNS連携による会員登録の場合は、login_id, email, email_verifiedは返却されません。

エラーレスポンス

エラー発生時のレスポンスは、共通仕様の共通エラーレスポンスを参照。

ログインID / パスワードによる認証

リクエストサンプル

レスポンスサンプル

SNS連携 Facebook による認証

リクエストサンプル

SNS連携 Twitter による認証

リクエストサンプル

匿名認証による認証

リクエストサンプル

(*5)〜idの値は大文字でも受け付けますが、アピアリーズ内部では大文字・小文字の区別はございません