Skip to main content

UserRegistration

UserRegistration

初回ユーザーEmail登録

Description

  • ログイン前のユーザーをシステムへ登録するためのフローを開始します。
  • サービス紹介サイトやLandingPage等から、初期ユーザーのメールアドレスを登録し、指定ユーザーへ登録リンクをメール送信します。

Method

POST

Request URL Format

/api/v0/users/registration

Payload

[方法1] SendGridへ設定されたメールテンプレートを利用する場合 Hexabase社へSendGrid情報を連絡し、利用するSendGrid情報に対するemail_template_idを指定します。(email_template_id取得前に開発を進める場合は、「デフォルトのメールテンプレートを利用する場合」を参照してください。)

{
"email":"メールを送信したい対象 例:[email protected]", //必須
"username":"登録したいユーザー名", //必須
"email_template_id": "5f25956428dc5c55b463bc77", // (Option) Hexabase社より発行されたメールテンプレートID
"registration_path":"サインアップしたユーザーを確認するためのパス", // (Option) デフォルト:'confirm_email'
"additional_info": // (Option) ユーザに紐づく属性情報(User系APIで取得・更新可能な値)
{
"ユーザーの指定したいフィールド1":"ユーザー指定の値1",
"ユーザーの指定したいフィールド2":"ユーザー指定の値2"
}
 },
"sender_address": "[email protected]" // (Option) メールのfromを任意の値に変更したい場合に指定します

[方法2] デフォルトのメールテンプレートを利用する場合

{
"email":"メールを送信したい対象 例:[email protected]", //必須
"username":"登録したいユーザー名", //必須
"registration_domain":"登録するドメイン", //必須
"hostname":"登録するホスト名", //必須
"protocol":"例 http, https",
"registration_path":"サインアップしたユーザーを確認するためのパス", // オプション (デフォルト: 'confirm_email')
"additional_info": // (Option) ユーザに紐づく属性情報(User系APIで取得・更新可能な値)
{
"ユーザーの指定したいフィールド1":"ユーザー指定の値1",
"ユーザーの指定したいフィールド2":"ユーザー指定の値2"
},
"sender_address": "[email protected]" // (Option) メールのfromを任意の値に変更したい場合に指定します
}

Request URL Sample

POST https://api.xxx.com/api/v0/users/registration

Response Sample

{
"confirmation_id": "確認ID",
"email": "初期登録されたemail",
"status": 200
}