User Registration (API)
Full stack of operations with users and users' profiles.
Please make sure you have InstanceID and InstanceKey ready. If not, please refer to the part of account registration
User service enables managing user's telematics parameters. It can be set up during registration or changed later via Update User method. This parameters will be used by default if you do not set up them manually.
Parameter | Description |
"EnableTracking" | Activate/Deactivate SDK tracking |
EnableLogging | Activate/Deactivate debug mode (IMPORTANT: this option causes a greater battery consumption. Use it carefully only while debugging!) |
EnableRealtimeLocation | Activate/Deactivate online location monitoring |
Enabled | Activate/Deactivate user (Note: deactivated user is not a deleted user. If you need to permanently delete user, use Delete User method) |
post
http://user.telematicssdk.com
/v1/Registration/Create
Register a new user
For transition period we are using Device Token, however it will be replaced with JWT token soon.
For the purpose of smooth transition, we recommend you to store JWT token and refresh token together with Device ID. Once we will be ready to move to JWT Token we will inform our clients respectively. Device Token will be supported over 12 month since announcement.
JWT token has a lifetime. After this period - it expires. When your JWT token is expired you should refresh your token.
We will support the old platform till November 01, 2021 and keep inform all our clients about progress and required steps.
Important: JWT Token will be used in other API Requests.
Optionally you can add user information to User Service as well as manage SDK tracking and data collection
Adding user information unlocks better experience working with DataHub. The more information you share, the more completed profile you will get in DataHub, as well as more data for portfolio categorisation.
Request Body
{
"CreateAccessToken": true, // default = true, - return jwt token in response for immediately using or use login to receive jwt
"FirstName": "string",
"LastName": "string",
"Nickname": "string",
"Phone": "string",
"Email": "string",
"Gender": "None", // { "None", "Male", "Female", "Other" }
"Birthday": "2019-12-13T06:19:18.837Z",
"MaritalStatus": "string",
"ChildrenCount": 0,
"Country": "string",
"District": "string",
"City": "string",
"Status": "Active", //default = active, - you can also create the "deactivated" user
"Address": "string",
"ImageUrl": "string" // photo url (you can upload your photo later),
"InstanceInviteCode": "string", // Registration in instance by invite code
"UserFields": { // default = null. Will be using dafult values below
"EnableTracking": true, // default = true - enable tracking user motion
"EnableLogging": false; // default = false - enable logging on mobile device
"Enabled": true, // default = true - enable telematics SDK
"ClientId": "string", // default = null. User ID in your system
}
}
post
/v1/Registration/CreateMany
Register multiple users
Request Body
{
"Quantity": 0, // required
"CreateAccessToken": true, // default = true
"CustomFields": {
"EnableTracking": true, // default = true
"EnableLogging": false; // default = false
"Enabled": true, // default = true
}
}
For any actions use JWT token. You can get it after registration (if GenerateAccessToken = true), Authorization and after RefreshToken.
Using: got 401 Error => refresh token => new JWT and refresh token.
Refresh token changes when Login and RefreshToken.
post
https://user.telematicssdk.com
/v1/RefreshToken
RefreshToken
Format of Body Request:
{
"AccessToken": "string", // required - JWT
"RefreshToken": "string" // required
}
Get more information about user management including Tracking activation and deactivation: