Get Your Credentials

All users of the HERE platform must obtain authentication and authorization credentials.

The following approaches are available for authenticating your application with the platform:

  1. using the platform credentials available from the platform portal in combination with the Data Client Library credential management system (recommended for development)
  2. using encrypted platform credentials and programmatically providing these credentials to the Data Client Library credential management system
  3. using the access key ID and access key secret in the platform credentials and the Authentication and Authorization Developer's Guide to create your own authentication and authorization client for retrieving HERE tokens, which you can then provide to the Data Client Library credential management system

To obtain your platform credentials, create a new application via the https://platform.hereolp.cn/profile/apps-and-keys page. When you have created your application, click Create A Key to download these credentials.

If you are using option one above, place the credentials in $HOME/.here/credentials.properties.

Note: Downloading the Data Client Library

To download the Data Client Library, you need repository credentials. To obtain your credentials, go to https://platform.hereolp.cn/profile/repository and click Create credentials, to download the settings.xml file.

Credential Options

The snippets below demonstrate different ways of supplying your platform credentials to the Data Client Library.

When you initialize a new service client without supplying any credentials as arguments, the Data Client Library attempts to find your platform credentials using the default credential provider chain: a platform credentials file in the JVM classpath, the default location platform credentials download location (~/.here/credentials.properties) and the Java system properties in that order.

Note: Billing Tags and Optional Projects Scope

The snippets below also demonstrate the use of HERE platform billing tags, which you can use in requests to the platform in order to later associate your requests with the invoicing for those requests.

A configuration property here.token.scope/here-token-scope is optional. It provides access to Project resources (catalogs, schemas, pipelines).

Set Your Credentials via the Application's Configuration File

This is the recommended approach.

Based on the values in the platform credentials, include the following parameters in your application.conf file:

HERE Account
here.platform.data-client.request-signer {
  billing-tag = "example_billing_tag"
  credentials {
    here-account {
      here-token-endpoint-url = "https://elb.cn-northwest-1.account.hereapi.cn/oauth2/token"
      here-client-id = "example-client-id"
      here-access-key-id = "example-access-key-id"
      here-access-key-secret = "example-access-key-secret"
      here-token-scope = "example-token-scope [optional]"
    }
  }
}

HERE Token
here.platform.data-client.request-signer {
  billing-tag = "example_billing_tag"
  credentials {
    here-token = "example-token"
  }
}

Set Your Credentials in the Credentials File

The Data Client Library can read HERE access key and access secret data from the credentials.properties file.

  • The client looks for a credentials.properties file in the Java Virtual Machine (JVM) classpath.

  • A fallback location to find platform credentials is in ~/.here/credentials.properties

  • Alternatively, you can specify an alternate credentials file location in the application.conf file.

  here.platform.data-client.request-signer {
    billing-tag = "example_billing_tag"
    credentials {
     file-path = "/path/credentials.properties"
    }
  }

Example of credentials properties file:

  here.user.id = example-here-user-id
  here.client.id = example-client-id
  here.access.key.id = example-access-key-id
  here.access.key.secret = example-access-key-secret
  here.token.endpoint.url = https://elb.cn-northwest-1.account.hereapi.cn/oauth2/token
  here.token.scope = hrn:here-cn:authorization:::project/example-project

Note: Using Previously Generated Tokens

Previously generated HERE tokens are not supported for the platform credentials file format.

Set Your Credentials via Java System Properties

To set your credentials via Java System Properties, define the following:

HERE Account
-Dhere.platform.data-client.request-signer.credentials.here-account.here-token-endpoint-url="https://elb.cn-northwest-1.account.hereapi.cn/oauth2/token"
-Dhere.platform.data-client.request-signer.credentials.here-account.here-client-id="example-client-id"
-Dhere.platform.data-client.request-signer.credentials.here-account.here-access-key-id="example-access-key-id"
-Dhere.platform.data-client.request-signer.credentials.here-account.here-access-key-secret="example-access-key-secret"
-Dhere.platform.data-client.request-signer.credentials.here-account.here-token-scope="example-token-scope [optional]"

HERE Token
-Dhere.platform.data-client.request-signer.credentials.here-token="example-token"

Set Your Credentials Programmatically

To set your HERE account programmatically, include the following in your project:

Scala
Java
val exampleHrn = HRN("hrn:here-cn:data:::demo-catalog")

val dataClient = DataClient()

val settings =
  DataClient().defaultSettings
    .withRequestSignerSettings(
      HereAccountRequestSignerSettings(
        hereClientId = "<here-account-client-id>",
        hereAccessKeyId = "<here-account-access-key-id>",
        hereAccessKeySecret = "<here-account-access-key-secret>",
        hereTokenScope = Some("<here-token-scope [optional]>")
      )
    )
    .withBillingTag("<billing-tag>")

val queryApi = dataClient.queryApi(exampleHrn, settings)
HRN exampleHrn = HRN.fromString("hrn:here-cn:data:::demo-catalog");

DataClient dataClient = DataClient.get(myActorSystem);

Settings defaultSettings = dataClient.defaultSettings();

HereAccountRequestSignerSettings hereAccountRequestSignerSettings =
    new HereAccountRequestSignerSettings.Builder()
        .withHereClientId("<here-account-client-id>")
        .withHereAccessKeyId("<here-account-access-key>")
        .withHereAccessKeySecret("<here-account-access-secret>")
        .withHereTokenScope("<here-token-scope [optional]>")
        .build();

Settings settings =
    defaultSettings
        .withRequestSignerSettings(hereAccountRequestSignerSettings)
        .withBillingTag("<billing-tag>");

QueryApi queryApi = dataClient.queryApi(exampleHrn, settings);

To set your HERE token programmatically, include the following in your project:

Scala
Java
val exampleHrn = HRN("hrn:here-cn:data:::demo-catalog")

val dataClient = DataClient()

val settings =
  DataClient().defaultSettings
    .withRequestSignerSettings(
      HereTokenRequestSignerSettings(
        hereToken = "<here-token>"
      )
    )
    .withBillingTag("<billing-tag>")

val queryApi = dataClient.queryApi(exampleHrn, settings)
HRN exampleHrn = HRN.fromString("hrn:here-cn:data:::demo-catalog");

DataClient dataClient = DataClient.get(myActorSystem);

Settings defaultSettings = dataClient.defaultSettings();

RequestSignerSettings hereTokenRequestSignerSettings =
    new HereTokenRequestSignerSettings.Builder().withHereToken("<here-token>").build();

Settings settings =
    defaultSettings
        .withRequestSignerSettings(hereTokenRequestSignerSettings)
        .withBillingTag("<billing-tag>");

QueryApi queryApi = dataClient.queryApi(exampleHrn, settings);

results matching ""

    No results matching ""