Sorry, you need to enable JavaScript to visit this website.

Register Admin Key


Service version: 1
Last edit: 2019.09.18

On this page


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

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in plain text.

curl command

curl -XPOST "Content-type: application/json" -d
   "secret": "your_secret"

POST request body

  "secret": "secret_key"

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.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of request parameters is not important.
Required parameters
Parameter Description
The base URL for calling the API.
Service version.
Value: 1
An API Key valid for the requested service.
Value: Your API Key
Optional parameters
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.

  "adminKey": "admin_key"

Response fields

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

Primary fields
Field Description
A generated Admin Key that can be used to administer location history objects.

HTTP response codes

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


Example: Register a customer account using a passed secret value.


POST request body (JSON)

  "secret": "My very secret secret"

Response body

  "adminKey": "UpP9m2jg4PU6fWAFnvskU33CwfW24e17P0oTC5byUfUzMElS"

▲ Return to top