利用開始
このトピックでは、資格情報 API およびプラットフォーム API の取得などのセットアップタスクを含む、 Data API を使用したはじめに のサポートに役立つ情報を提供します。
データを探索します
データを把握する最も簡単 な方法は、 HERE platform ポータルを使用してデータを探索することです。 ナビゲーションバーの [ データ ] をクリックして、アクセス権を持っているカタログおよびレイヤーのリストを表示します。これには、 HERE Data や、共有されているユーザー提供のデータが含まれます。
ネットワークに関する考慮事項について理解する
Data API に確実に接続できるように、次の点に注意してください。
- HERE platform REST API は、 HTTP 1.1 標準に準拠しています。
- HERE platform への接続には、 TLS 1.2 以降が必要です。 SSL は使用しないでください。
- HTTP リダイレクトを予期します。 HERE platform では、標準の HTTP 1.1 リダイレクションステータスコードが使用されます。このステータスコードを使用して、アプリケーションでリダイレクトを処理できます。
資格情報を入手します
REST API を使用するに credentials.properties
は、ファイルが必要です。 このファイルは、 platform.here.com から入手できます。 資格情報のプロパティファイルが作成されたら、コンピュータの次のフォルダに保存してください。
~/. HERE / credentials.properties
credentials.properties
ファイルの取得方法の詳細について は、『 Identity & Access Management Guide 』を参照してください。
承認トークン を取得します
HERE platform REST リクエストを認証するには、 Authorization ヘッダーに OAuth 2.0 トークンが必要です。 認可トークンを取得するには、 Authentication and Authorization API を使用します。 この API の使用方法については 、『 ID およびアクセス管理ガイド』を参照してください。
api-lookup
このサービスを使用して、すべてのプラットフォーム API のベース URL を取得します。 プラットフォーム API は、特定のカタログに関連付けられていない API です。 すべてのプラットフォーム API のリストを取得するには、次のリクエストを作成します。
GET /lookup/v1/platform/apis HTTP/1.1
curl -X GET
-H "Authorization: Bearer <Authorization Token>"
-H "Cache-Control: no-cache"
https://api-lookup.data.api.platform.here.com/lookup/v1/platform/apis
応答は、ベース URL を含む、アクセス権を持つプラットフォーム API のリストです。
api-lookup
API の詳細について は、『 API Lookup 開発者ガイド』を参照してください。
カタログを検索します
api-lookup
サービスからプラットフォーム API ベースの URL のリストが作成 config
されたので、いずれかのサービスを使用して、利用可能なカタログのリストを取得できます。 次に示すように、サービス config
を通して取得したサービスのベース URL を指定し、 api-lookup
[Authorization] ヘッダーで指定した認可トークンを指定して、要求を作成します。
GET /config/v1/catalogs HTTP/1.1
curl -X GET
-H "Authorization: Bearer <Authorization Token>"
-H "Cache-Control: no-cache"
https://<Hostname for config>/config/v1/catalogs
応答は、アクセス権を持っているカタログの一覧表です。
注
数万以上のカタログへのアクセス権があり、結果の生成に 50 秒以上かかる場合は、一部の応答が返されることがあります。 このテストでは、 50000 のカタログへのアクセス権を持つユーザーが結果を生成するまでに約 50 秒かかることが示されています。
カタログの API ベースの URL を取得します
HERE platform では、 API のベース URL は、 API によって処理される HERE リソースネーム ( HERE リソースネーム )ごとに一意です。 つまり、 HERE platform は、各 REST API に静的なベース URL を持たずに、各 HERE リソースネーム の API ごとにベース URL を生成します。 たとえば publish
、カタログ A のサービスの基本 URL が publish
、カタログ B のサービスの基本 URL と異なります
api-lookup
サービスを使用して、カタログの API ベースの URL を取得できます。この URL では、カタログの HERE リソースネーム を指定します。
GET /lookup/v1/resources/<HRN>/apis HTTP/1.1
curl -X GET
-H "Authorization: Bearer <Authorization Token>"
-H "Cache-Control: no-cache"
https://api-lookup.data.api.platform.here.com/lookup/v1/resources/<HRN>/apis
応答は、カタログの API のリストです。
利用可能な API およびカタログが発見されたので、データの取得や公開、カタログの作成などの一般的なタスクを実行できます。
Data API の詳細については、『 API リファレンス』を参照してください。
データを操作するその他の方法
HERE platform 以外にも、 REST API ではデータを操作する他の方法が提供されています。
HERE platform ポータルでは、基本的なデータ管理機能やデータの視覚化にアクセスできます。 プラットフォームポータルは、次の用途に役立ちます。
- データの探索と分析を行うビジネスアナリスト、データサイエンティスト、開発者
- データを管理する開発者および管理者
- データ処理の出力を地図に表示したい開発者
コマンド ライン インターフェース ( CLI )
コマンド ライン インターフェース ( CLI )は、 プラットフォーム ポータル で使用できるのと同じデータ管理機能(カタログおよびレイヤーの作成、カタログおよびレイヤーの一覧表示、メタデータ の取得など)を提供しますが、 OLP CLI では、これらのコマンドをプログラムによって実行できます。 さらに、コマンドをスクリプトに保存しておくと、繰り返し実行するコマンドを最初から書き換えることなく簡単に実行できます。
CLI は、次の用途に役立ちます。
- プラットフォームポータルで利用できる機能へのプログラムによるアクセスを希望する開発者
- スクリプト内のデータ管理タスクを自動化する開発者および管理者
詳細については 、『 HERE platform CLI Guide』を参照してください。
注
CLI にアクセスするには、 HERE Workspace プランが必要です。
データ クライアント ライブラリ
データ クライアント ライブラリは、 HERE platform へのデータの読み取りおよび書き込みに使用できる Java/Scala ライブラリです。 REST API から抽象化されたレイヤーを提供し、 HERE platform API の進化に伴う変更からユーザーを保護します。 また、データ クライアント ライブラリを使用すると、データの読み取りと書き込みの複雑さが軽減され、 HERE platform データのやり取りをアプリケーションに追加する時間が短縮されます。
データ クライアント ライブラリ は、 Data SDK for Java and Scala の一部です。このツールには、さまざまな HERE platform コンポーネントサービスと、認証や承認などの他のインフラストラクチャレベルのサービスとの統合を容易にするツールが含まれています。 Data SDK for Java and Scala を使用すると、低レベルのコードを記述するのではなく、ビジネスニーズに合わせて変換を設計できます。
詳細については 、『 HERE Workspace for Java and Scala Developers Guide』を参照してください。
注
マーケットプレイスユーザーで、 HERE Workspace プランを持っていない場合、 Java および Scala の Data SDK へのアクセス権がありません。 データ クライアント ライブラリのダウンロードについては、マーケットプレイスのコンシューマーユーザーガイドまたはマーケットプレイスプロバイダユーザーガイドを参照してください。