Get Catalog Data

After you have executed a licensing agreement with a Marketplace provider and subscribed to data, you can access the data in the catalog using the Data Client Library. A catalog is a data storage that is available for the Marketplace provider or Marketplace consumer to access at any time.

Data Client Library provides Java/Scala libraries for reading data from catalogs.

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.

To get data from the catalogs you have subscribed to:

  1. Register your app and generate app credentials.
  2. Set up your development environment.
  3. Add the Data Client Library to your project.
  4. Use the Data Client Library to read data from a catalog.

Register Your App and Generate App Credentials

In order for your application to access data in the platform, you must register your application by generating an ID and credentials for the application.

For instructions on registering your application and generating app credentials, see Manage Apps.

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

Note

You cannot access data in catalogs until your organization's the platform administrator has added your application's app ID to your organization platform group.

Set Up Your Development Environment

Make sure your system has the required software installed. The required software is listed in Prerequisites.

Note

In Prerequisites, ignore steps 7 and 8 in the section titled "Get Credentials". These do not apply to Marketplace users.

Your environment is set up correctly if there are no errors.

Add the Data Client Library to Your Project

By means of the HERE Maven Wagon plugin, you can integrate the Data Client Library into Maven projects. For SBT projects, you can use the unofficial HERE SBT Resolver plugin.

Maven Project

To use the Data Client Library in your Maven project, add the following snippet to your pom.xml file:

<repositories>
    <repository>
      <id>HERE_PLATFORM_ARTIFACT</id>
      <layout>default</layout>
      <url>here+artifact-service://artifact-service</url>
    </repository>
  </repositories>

  <dependencies>
    <dependency>
      <groupId>com.here.platform.data.client</groupId>
      <artifactId>data-engine_2.12</artifactId>
      <version>1.18.138</version>
    </dependency>
  </dependencies>

  <build>
    <extensions>
      <extension>
        <groupId>com.here.platform.artifact</groupId>
        <artifactId>artifact-wagon</artifactId>
        <version>2.0.19</version>
      </extension>
    </extensions>
  </build>
</repositories>

SBT Project

To use the Data Client Library in your SBT project, add the following snippet to your projects/plugins.sbt file:


addSbtPlugin("com.here.platform.artifact" % "sbt-resolver" % "2.0.14")

And add the following snippet in your build.sbt file:


resolvers += "HERE_PLATFORM_ARTIFACT" at "here+artifact-service://artifact-service"

libraryDependencies += "com.here.platform.data.client" %% "data-engine" % "1.18.138"

Note

The SBT resolver plugin is provided 'as is' and not officially part of Marketplace. While there is no official support by HERE, you may still raise issues via GitHub.
HERE may be able to help.

Use the Data Client Library to Read Data from a Catalog

Now that you have set up your environment, see Get Data in the Data Client Library Developer Guide for information on using the Data Client Library to read data from a catalog.

Additional Information

Here are the key concepts you should understand related to platform data:

results matching ""

    No results matching ""