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.

Request Body

NameDescriptionData Type
apiKeyAPI key provided by Trimble Maps
string

Response

NameDescriptionData Type
tokenAuth token that expires after a set time interval
string
expiresThe 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

MessageDescription
Invalid apiKey value sentThis error is thrown when API key is invalid.
Last updated August 4, 2022.