Picture

Important feature

API Authentication

All Hometrack APIs are secured using OAuth2 via the Auth0 unified authentication platform. This page shows the steps to authenticate against a Hometrack API.

Step 1 - Token generation

The first step is to get the access token from the Auth0 authentication provider using an HTTP POST request sent to:

https://hometrack-prod.eu.auth0.com/oauth/token

The BODY of the request must contain the following information as a JSON document:

  • Client Id and Secret used to uniquely identify your subscription to the Hometrack API

{
"client_id": "abcdefghijklmnopqrstuvwxyz0123456789",
"client_secret": "abcdefghijklmnopqrstuvwxyz0123456789",
"audience": "https://api.hometrack.com",
"grant_type": "client_credentials"
}

Step 2 - Receiving access token from Auth0

An access token will be included in the JSON response returned by Auth0. The access token is valid for 24 hours.

A response example response is shown below:

{
"access_token": "abcdefghijklmnopqrstuvwxyz0123456789",
"scope": "read:valuations write:valuations",
"expires_in": 86400,
"token_type": "Bearer"
}

Step 3 - Make a call to a Hometrack API

Using the token obtained in step 2 above make a call to the API, for example the Valuation Order API:

https://api.hometrack.com/valuation/v2

Make sure to include Authorization token of type Bearer. In Postman this will look as follows:

Picture