User Sign Up
Since the signup process involves filling in the password, the signup HTML view is provided by the API, not by the client. To create a user account, the client application must point the user agent to the signup page, by issuing the following request:
curl --location --request GET 'https://api.services-smarthome.de/ACCOUNT/1.1/signup?clientId=<clientID>&redirectUrl=<URIEncodedRedirectURI>&lang=en-GB'
Following request parameters have to be provided:
clientID
must be set to the specific client application identifierredirectUrl
is the URI to which the user agent should be redirected. This URI should be part of the client application and must be registered with LIVISI beforehand. There are 3 cases in which the redirect URI is used:- After the user aborts the signup process.
- After the email address is confirmed.
- After the signup is completed.
Optional parameters:
lang
defines the language in which the login page shall be displayed. Supports de-DE, en-GB, fr-FR and nl-NL. Defaults to de-DE.
The API then replies with HTML content that should be displayed to the user:
The user has also the option to abort the signup procedure by pressing the <- button.
In this case the
redirectUrl
is called so the client can react to this flow.
After the account details are filled in, they are POSTed to the API, which creates the a temporary user account, sends a confirmation email to the users address and displays a HTML view that informs them that they should check their email account.
Clicking the TO HOMEPAGE button will call the previously defined redirectUrl
.
Example of LIVISIs confirmation e-mail:
Clicking the CONFIRM E-MAIL button makes the following request:
https://api.services-smarthome.de/account/1.1/signup/<username>?code=<code>&lang=en-GB
This takes the user to a HTML view on which states that the e-mail address was confirmed:
The temporary user account was now converted into a full use account. Clicking the TO HOMEPAGE button will call the previously defined redirectUrl
.
Area: Account API