Register Admin Key

Service version: 1
Last edit: 2022.07.21

Purpose

This endpoint is used to register a customer. Before a customer can use the service, or act as an Admin for Location History 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 their values. The generic request format is as follows.

URL format

POST
URL request
https://{baseURL}/locationHistory/{versionNumber}/register?key={Your_API_Key}

curl command format

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

POST request body

POST
POST request body
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.

Required parametersDescription
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version.
Value: 1
key
string
An API Key valid for the requested service.
Value: Your API Key

Response data

Response body

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

Response body - JSON
1{
2 "adminKey": "admin_key"
3}

Response fields

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

Primary fieldsDescription
adminKey
string
A generated Admin Key that can be used to administer location history objects.

Response codes

CodeMeaning & possible causes
200OK: Configuration registered. Admin Key regenerated.
400Bad request: Missing or invalid request data.
403Forbidden: Each customer can register only one configuration.

Example

Register a customer account using a passed secret value.

Request URL

POST
POST request URL
https://api.tomtom.com/locationHistory/1/register?key={Your_API_Key}

POST request body

POST
POST request body - JSON
1{
2 "secret": "My very secret secret"
3}

Response body

Successful response - JSON
1{
2 "adminKey": "UpP9m2jg4PU6fWAFnvskU33CwfW24e17P0oTC5byUfUzMElS"
3}