Customer registration

Customers can create accounts that let them authorize and perform operations such as redeeming coupons, making purchases, managing their own data, and more. The data is available for you to see and modify in the customer’s CRM profile; the primary unique identifier in Synerise is the email address.

A customer can also exist in the CRM if they don’t have a self-managed account.

For more details on CRM profiles, see CRM profile management.

Registering a customer with RaaS

Registration as a Service (RaaS) creates an account in Synerise without any third-party integrations. It may be configured to require email confirmation. The basic request only requires an email, password, an UUID, but you can provide additional information. See method reference.

curl --location --request POST 'http://api.synerise.com/sauth/clients/registered' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Version: 4.4' \
--header 'Authorization: Bearer eyJhb...Ndo' \
--data-raw '{
    "email":"sampleclient@synerise.com",
    "password":"strongpassword",
    "uuid":"b3f56868-9667-4843-a8e5-0509456baa9b",
}'

Account activation

Synerise RaaS may be configured for three types of account confirmation:

  • Automatic: the account is ready to use immediately. The snrs_email_confirmed attribute in the customer is FALSE.
  • Email confirmation required: the account is ready to use, but confirmation is required to set the snrs_email_confirmed attribute in the customer profile to TRUE.
  • Email activation required: the account cannot be accessed until it is confirmed. Activation sets the snrs_email_confirmed attribute in the customer profile to TRUE.

When the customer registers, an activation email is sent automatically.

Activating/confirming the account

Method reference available here.

Prerequisites:
Email sender integration must be enabled.

The token is sent to the customer’s email after registration.

curl --request POST 
  --url https://api.synerise.com/sauth/clients/activation/confirmation 
  --header 'authorization: Bearer eyJh...JxkM5o' 
  --header 'content-type: application/json' 
  --data '{
      "token":"eyJh...JwcR4z"
    }'

Result: The account is activated/confirmed and ready to use.

Requesting a new activation/confirmation token

Method reference available here.

Prerequisites:
Email sender integration must be enabled.

If the activation token expires or the message was not delivered, you can request a new token.

curl --request POST 
  --url https://api.synerise.com/sauth/clients/activation/request 
  --header 'authorization: Bearer eyJh...JxkM5o' 
  --header 'content-type: application/json' 
  --data '{
      "email":"sampleclient@synerise.com"
    }'

Result: The email with the token is re-sent.

Registering a customer with OAuth

Registering with OAuth creates a customer account in Synerise, but a customer account must also exist in your own database to serve as a basis for OAuth authentication.

Important: This endpoint can be used for logging in - if an account already exists, the response is a Synerise JWT that can be used for authorizing further requests as the customer.

The following is a basic request, but you can provide more information. See method reference.

accessToken is the token that is sent by Synerise backend to your OAuth implementation.

curl --location --request POST 'https://api.synerise.com/sauth/auth/login/client/oauth' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Version: 4.4' \
--header 'Authorization: Bearer eyJhb...Ndo' \
--data-raw '{
    "apiKey":"01234abc-1234-5678-9abc-def012345678",
    "accessToken": "eyJhbG...JsbSI6ImNsa"
    "uuid":"b3f56868-9667-4843-a8e5-0509456baa9b",
}'

Registering a customer with Facebook Login

Registering a customer with Facebook Login requires that your application is integrated with Facebook. For more details, see the Facebook Developer Documentation.

Important: This endpoint can be used for logging in - if an account already exists, the response is a Synerise JWT that can be used for authorizing further requests as the customer.

The following is a basic request, but you can provide more information. See method reference.

curl --location --request POST 'https://api.synerise.com/sauth/auth/login/client/facebook' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Version: 4.4' \
--header 'Authorization: Bearer eyJhb...Ndo' \
--data-raw '{
    "apiKey":"01234abc-1234-5678-9abc-def012345678",
    "facebookToken": "eyJhbG...JsbSI6ImNsa"
    "uuid":"b3f56868-9667-4843-a8e5-0509456baa9b",
}'

Registering a customer with Sign in with Apple

Registering a customer with Sign in with Apple requires that your application is integrated with Sign in with Apple. For more details, see the Apple Developer Documentation.

Important: This endpoint can be used for logging in - if an account already exists, the response is a Synerise JWT that can be used for authorizing further requests as the customer.

The following is a basic request, but you can provide more information. See method reference.

accessToken is the token that is sent by Synerise backend to Apple authentication mechanisms.

curl --location --request POST 'https://api.synerise.com/sauth/auth/login/client/apple' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Version: 4.4' \
--header 'Authorization: Bearer eyJhb...Ndo' \
--data-raw '{
    "apiKey":"01234abc-1234-5678-9abc-def012345678",
    "accessToken": "eyJhbG...JsbSI6ImNsa"
    "uuid":"b3f56868-9667-4843-a8e5-0509456baa9b",
}'
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.