Skip to main content

Authenticate API Calls

Resource URL

https://api.trimblemaps.com/places/v1/authenticate

POST /authenticate

Use the API key provided in the authentication request to the server. If the authentication is successful, the server creates and sends a JSON Web Token (JWT) in the response. To access the API resources, all subsequent requests must pass the JWT in the request header, using the format:

Authorization: bearer {token}

Request Body

Name Description Data Type
apiKey API key provided by Trimble Maps
string

Response

Name Description Data Type
token Auth token that expires after a set time interval
string
expires The date and time at which the token is set to expire
DateTime

Sample Response

{
  "token": "string",
  "expires": "2020-03-21T19:18:23.228Z"
}

Error Codes

Message Description
Invalid apiKey value sent This error is thrown when API key is invalid.
Last updated April 20, 2023.