REST API 会員API
最終更新日 2015-9-1

メールアドレス確認通知を依頼する

メールアドレスを登録します。

基本仕様

アピアリーズの会員管理を利用して、メールアドレスを登録します。

本REST API(メールアドレスを登録する)はコントロールパネルの会員管理 / 基本設定にて、メールアドレスの登録設定するで設定の場合に有効化されます。また、本REST APIへリクエスト実施後にメールアドレス確認の通知が送信され、メールアドレス確認の通知本文に記載されているURLをクリックし表示される画面にてパスワードを登録後、メールアドレス / パスワードでのログインが可能となります。(*1)

(*1)〜コントロールパネル / 基本設定にて、 会員のメールアドレス認証設定するで指定されている場合。

HTTPメソッド

POST

エンドポイント

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

リクエスト

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

ヘッダ

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

クエリ

キー 必須 説明
access_token △(*2)

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

コンテント

キー 必須 説明 データ型 備考
email メールアドレス String (*3)

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

成功時レスポンス

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

ヘッダ

キー名 説明 備考
Content-Type application/json

HTTPステータス

ステータスコード 説明
202 メールアドレス確認通知の依頼が受け付けられました。

コンテント

無し。

エラーレスポンス

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

リクエストサンプル