Register Admin Key

Decommission notice

Purpose

This endpoint is used to register a customer.

• Before a customer can use the service, or act as an Admin for Geofencing endpoints, they must register.
• Registering creates a configuration for the customer and creates an Admin Key, used to create/edit/delete Location History data.

Request data

HTTPS method: POST

• Constants and parameters enclosed in curly brackets { } must be replaced with their values.
• Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL request format

1
https://{baseURL}/geofencing/{versionNumber}/register?key={Your_API_Key}

curl command request format

1
curl -XPOST "Content-type: application/json" -d
2
'{
3
   "secret": "your_secret"
4
 }'
5
'https://{baseURL}/geofencing/{versionNumber}/register?key={Your_API_Key}'

POST request body format

1
{
2
  "secret": "secret_key"
3
}

Request parameters

The following table describes the parameters that can be used in a request.

• Required parameters must be used or the call will fail.
• Optional parameters may be used.
• The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Response data

Response body

The following JSON code block demonstrates a successful response from the API server.

1
{
2
  "adminKey": "admin_key"
3
}

Response fields

The following table describes all of the fields that can appear in a response.

Example

Register a customer account using a passed secret value.

HTML Method: POST

1
https://api.tomtom.com/geofencing/1/register?key=yPMFGLgBoejrRoWS8qYS

POST request body example

1
{
2
  "secret": "My very secret secret"
3
}

Response body example

1
{
2
  "adminKey": "UpP9m2jg4PU6fWAFnvskU33CwfW24e17P0oTC5byUfUzMElS"
3
}