Skip to main content

UserRegistration

Register the user's email address for the first time.

Description​

  • Starts the flow for registering the user before logging in to the system.
  • Register the email address of the initial user from the service introduction site, landing page, etc., and send the registration link to the specified user by email.

Method​

POST

Request URL Format​

/api/v0/users/registration

Payload​

[Method１] To use an email template set to SendGrid Contact Hexabase for SendGrid information and specify the email_template_id for the SendGrid information to be used.(If you want to proceed with development before obtaining the email_template_id, please refer to "Using the default email template".)

{
  "email":"メールを送信したい対象 例:[email protected]", //Required
  "username":"登録したいユーザー名",　//Required
  "email_template_id": "5f25956428dc5c55b463bc77",  // (Option) Email template ID issued by Hexabase
  "registration_path":"サインアップしたユーザーを確認するためのパス", //  (Option) Default：'confirm_email'
  "additional_info": // (Option) Attribute information associated with the user (values that can be obtained and updated by the User API)
    {
      "Field 1 is to be specified by the user":"User specified value 1",
      "Field 2 is to be specified by the user":"User specified value 2"
    }
　},
  "sender_address": "[email protected]" // (Option) Specify if you want to change the email to any value

[Method２] To use the default email template

{
  "email":"メールを送信したい対象 例:[email protected]", //Required
  "username":"登録したいユーザー名", //Required
  "registration_domain":"登録するドメイン",　//Required
  "hostname":"登録するホスト名",　//Required
  "protocol":"例　http, https", 
  "registration_path":"サインアップしたユーザーを確認するためのパス", // Option (Default： 'confirm_email'） 
  "additional_info": // (Option) Attribute information associated with the user (values that can be obtained and updated by the User API)
    {
      "Field 1 is to be specified by the user":"User specified value 1",
      "Field 2 is to be specified by the user":"User spcified value 2"
    },
  "sender_address": "[email protected]" // (Option) Specify if you want to change the email to any value.
}

[Method３] If you do not want to send emails (for example, you want to use an email service other than SendGrid)

{
  "email":"Target to send email to Example:[email protected]", //Required
  "username":"Username you want to register", //Required
  "no_confirm_email": true // If true, Hexabase standard Sendgrid email will not be sent.
}

Request URL Sample​

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

Response Sample​

In case of [Method１][Method２] 

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

In case of [Method３] 

{
  "confirmation_id": "Confirmation ID", 
  "email": "Initial registered email"
}