Get started

This section provides information on the minimum setup required to quickly begin managing the costs of your organization. An organization (org) contains all the users, apps, and resources within the same security namespace. When you log into the HERE platform, you must enter your organization ID.

This section outlines how to quickly get started using Cost Management:

1. Get a HERE account
2. Get credentials
3. Register your app
4. Get an OAuth token
5. Send a request
6. Next steps

Get a HERE account

In order to access the HERE platform Usage API, you need to obtain a HERE account. Learn more at Get a HERE account.

Get credentials

To use the REST API, you need to have a credentials.properties file. You can obtain this file from platform.here.com. Once you have your credentials properties file, make sure to put it in this folder on your computer:

~/.here/credentials.properties

For more information about obtaining a credentials.properties file, see the Identity and Access Management Guide

Register your app

To register your app, follow the steps in Identity and Access Management Guide-OAuth Tokens.

Now that your app is registered, you can get OAuth 2.0 tokens to authenticate requests. You must code your application to get an OAuth 2.0 token for each request to a HERE service.

Get an OAuth token

There are multiple ways to get a token:

• Get a token with the CLI
• Get a token with the SDK or an API

Having followed one of the previous methods, you have successfully obtained a token to use to make REST requests to the API.

Include the token in the HTTP Authorization header of your REST requests as a bearer token:

Authorization: Bearer <token>”

Send a request

Once you have created a HERE account and have your credentials, you can test them by sending any request. Include the token in the HTTP authorization header before you send the request. A successful response from your request verifies that your credentials are setup correctly. For example, the following request shows how to get your usage using the feature ID.

Get usage by feature ID

This example uses org123456789 for the realmId and hrn:here:service::org123456789:search-geocoding-1 as the featureId.

Request

       GET https://usage.bam.api.here.com/v2/usage/realms/org123456789?startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51&featureId=hrn:here:service::org123456789:search-geocoding-1

Response HTTP 200 OK

The following is a successful response to get usage by feature ID.

    HTTP 20O OK

{
  "total": 10,
  "limit": 100,
  "items": [
    {
      "realmId": "org123456789",
      "billingSubscriptionId": "",
      "billingChargeNumber": "",
      "featureId": "hrn:here:service::org123456789:search-geocoding-1",
      "category": "service",
      "name": "Geocoder Autosuggest",
      "valueDriver": "Transactions",
      "usageValue": "10",
      "billableValue": "10"
    },
  ],
  "nextOffset": 0,
  "lastOffset": 0
}

Next steps

We encourage you to view the tutorials, which walk you through various cost scenarios, and explain how to use the Usage API, starting with the simplist, Get usage by organization. Parameters used in the tutorials and responses are described in detail in the API Reference.