Authenticate

Returns an access token to be used in Places API requests.

An API key can be obtained by contacting Trimble MAPS support.

post/places/v1/authenticate

Request

Base URL: https://api.trimblemaps.com
URL: https://api.trimblemaps.com/places/v1/authenticate
Auth: API key in header Authorization

Request body

apiKeystring required

The API Key.

Example request

{
  "apiKey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456"
}

Response

Success

tokenstring nullable

The JWT used to access Places API.

expiresstring date-time nullable

The date and time this token expires.

messagestring nullable

Gets or sets the error message.

Example response

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "expires": "2020-03-03T15:01:29.9007619+00:00",
  "message": "The API Key was not found."
}

Changes

No recorded changes to this operation across all 1 revision of this API.