GuidesAPI Reference
Guides

Get started with HERE WeGo Pro Live Tracking API

Before you request meaningful tracking data from the HERE WeGo Pro Live Tracking API, make sure your subscription and drivers are ready:

  • Create a HERE WeGo Pro subscription for yourself or your customer, and add Live Tracking. Live Tracking requires an additional contract.

  • Confirm that the subscription was successfully created and that Live Tracking is available for it.

  • Onboard drivers to the subscription in the HERE WeGo Pro app by using an activation key or a similar method.

  • Confirm that drivers are properly onboarded.

  • Verify that Live Tracking is active in the app:

    • Drivers have opened the app or started guidance.
    • On iOS, the app remains open.
    • On Android, the app is open or active in the background.
    • Enough time has passed for data to reach the backend. By default, the first tracking record is available 5 minutes after guidance starts.

Once you complete these prerequisites, the backend can provide tracking data.

Step 1: Obtain an API key

As part of your HERE platform or HERE WeGo Pro setup, you receive an API key that allows your app to access the HERE WeGo Pro backend.

Pass the HERE WeGo Pro API key as the apiKey query parameter:

?apiKey=YOUR_WEGO_PRO_API_KEY

Example request URL:

https://api.wego.hereapi.com/user-service/users/tracking/report?apiKey=YOUR_WEGO_PRO_API_KEY

Step 2: Obtain an org manager access token

Your technical contact at HERE provides a way to get a HERE Platform access token for a specific user.

The access token must meet the following requirements:

  • The token is valid and hasn't expired.
  • The token represents a user who is an Org Manager in the same HERE WeGo Pro organization as the tracked devices.
  • If the user isn't an Org Manager for the organization, the API returns a 403 error with the message Not an admin user.

Authenticate the caller with a HERE platform access token by using one of the following headers:

 Authorization: Bearer <ACCESS_TOKEN>

Or

X-Authorization-Iam: Bearer <ACCESS_TOKEN>

If any of these conditions aren't met, the API returns an error. For more information, see HTTP error codes.

Step 3: Set up the HERE WeGo Pro app

Before using Live Tracking, set up the HERE WeGo Pro app for your drivers. For more information, see HERE WeGo Pro User Guide-Get started.

Step 4: Request a Live Tracking report

After you complete the setup, request a Live Tracking report. For more information, see Live tracking report