- Developers
- Professional Navigation for Fleets
- Android
- Installation and Activation
- Remote Activation with Rest API
Remote Activation with Rest API
Introduction
This is the Rest API function for remote activation of your devices based on a selection of one of your purchased product.
The enabler for such an activation is the possesion of API key, which is associated with your license administration account.
URL
POST https://api.bls.sygic.com/api/v1/activate?productId={productId}&purchasePeriod={purchasePeriod}
Mandatory query string parameters
Parameter | Description |
---|---|
productId | Id of activated product |
purchasePeriod | Purchase period in months |
Mandatory headers
Header | Description |
---|---|
X-api_key | Your api key |
Body
[
{
"licenseIdentifierType":"device",
"identifier":"deviceIdentifier",
"note": "activationnote"
},...
]
Body is an array of elements where
Field | Description | Mandatory |
---|---|---|
licenseIdentifierType | One of "device", "email" | Yes |
identifier | Respective device identifier or user's email | Yes |
note | Optional note | No |
Example
Request
[
{
"licenseIdentifierType":"device",
"identifier":"3647738928928932"
}
]
Response
Success
{
"message" : "License successfully activated",
"successfulCount": 1,
"errors": {},
"responses": {}
}
Invalid Api Key
{
"message": "Wrong API key !"
}
Already Activated
{
"message" : "Already activated",
"successfulCount": 0,
"errors": {
"alreadyActivated": ["deviceIdentifier",...]
},
"responses": {}
}
Invalid Product and Purchase period combination
{
"message" : "Invalid product",
"successfulCount": 0,
"errors": {
"invalidProduct": [
"[Product:productId, Activation Type:Web, Purchase Period:purchasePeriod]"
]
},
"responses": {}
}
- Previous article: Remote Activation for offline devices
- Next article: Activation with product codes