Get Neutral Server Data

After you have executed a licensing agreement with a Marketplace Provider and subscribed to the Neutral Server data, you can access the Neutral Server container data. A Neutral Server container is a set of data (resources), provider by the Data Provider, and available to the Data Consumer in the form of listings through HERE platform.

Note

You must have HERE platform account to proceed. If you do not have an account, contact your organization's HERE platform administrator and request to be invited to HERE platform as described in Add and Manage Groups.

Get Credentials

To access HERE platform data with your application, register the app and generate an ID and credentials.

For more information on how to register an application and generate app credentials, see Manage Apps.

Once your application is registered, provide the app ID to the person who manages HERE platform groups for your organization. That person must add the app ID to HERE platform group that grants access to the catalog you want. For more information, see Add and Manage Groups.

You also require an Authorization Token to get access and check the consent request status, for example. Read more on how to request a token.

To help you manage token requests, HERE offers the Authorization, Authentication, and Accounting SDK. This SDK includes a sample application that you can use to request tokens. You can access the Authorization, Authentication and Accounting SDK at our GitHub account. See the GitHub repository README for instructions on compiling and running the sample application.

Neutral Server API references include the following parameters that are available to the Data Consumer at the Marketplace subscription page:

  • Container ID - Identification ID of a Container of the Offering Party.
  • Campaign ID - is a number at the end of the URL that you get after you create a consent request.

Get Container Resources

A consent request page with Container ID and Campaign ID
Figure 1. A consent request page with Container ID and Campaign ID

To get container resources, make the following request, using Container ID and Campaign ID:

GET /providers/{providerHrn}/vehicles/{vehicleId}/containers/{containerId}
{providerHrn}: Data Provider HRN
{vehicleId}: Vehicle identification number of a car
{containerId}: Container Id

Request must be provided with headers:

Authorization: valid HERE token of data consumer
Campaign ID:

Example of a successful response:

Status code 200

Body:

{
    "distancesincestart": {
        "value": "276",
        "timestamp": 1592561349847
    },
    "odometer": {
        "value": "3005",
        "timestamp": 1592561349847
    },
    "distancesincereset": {
        "value": "1234",
        "timestamp": 1592561349847
    }
}

In case of a wrong Authorization token, you get a response:

Status code 403

Body:

{
    "error":"Forbidden",
    "error_description": "These credentials do not authorize access"
}
{ 
    "title": "Request processing exception",
    "code": "E501114",
    "cause": "Data provider 'daimler' response: Resource not found",
    "action": "Modify request according to data provider requirements"
}

In case the consent id is missing, you get a response:

{
    "title": "Consent token not found",
    "status": 404,
    "code": "E501126",
    "cause": "Token is not provided for consent request id 'null'",
    "action": "Clarify with Consent Management team if requested vehicle id has consent",
    "correlationId": "1e5748d6-a788-4c61-bb88-78418da6e8aa"
}

Note

Each execution of the specific resource call corresponds to a purchased call. If no data is available for the resource within 12 hours, the response will be empty. The endpoint returns the http status code 204, and no payment is required for the request.

  • Authorization - HERE platform Bearer Token for Authentication and Authorization. Go to HERE website and log into your HERE account. Open Apps & keys page to create a new app and get credentials, and a token. Read more on how to request a token.
  • ProviderHRN - Data Provider HRN. For example, hrn:here:neutral::olp-here-ns-realm:provider_id.
  • VehicleID - Vehicle identification number (VIN). For example, JH1TB2H25CC000000.
  • CampaignID - is the number at the end of the URL, that Consumer receives in return to the consent request. For example, 76e99605-20f1-468e-9c54-29d6c49127aa.
  • ContainerID - is the name of the container in the description of the ContainerID.

For more details on how to check the consent request status for a specific VIN number and/or check the common consent request status: the number of pending, approved and revoked consent requests, see Check Consent Request Status.

results matching ""

    No results matching ""