API

OLP CLI は、次の HERE API コマンドをサポートしています。

• API アクセスのためのトークンを取得します
• 一般的なプラットフォーム全体の API を一覧表示します

API トークン取得

HERE API との安全かつ安全な通信を可能にするアクセス トークンを返します。

olp api token get

オプションのパラメータ :

• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
• --json コマンドの結果を JSON 形式で表示します。
• --quiet 新しい行にベース URL を表示します。

例 :

以下のコマンドを使用すると、 HERE API の呼び出しに使用できるアクセス トークンを取得できます。

olp api token get --json

出力 :

{
    "accessToken": "eyJhbGciOiJSUz...omKF5Mg-sBjryw",
    "expiresAt": "2019-02-19T16:17:26.388Z"
}

API リスト

HERE platform によって提供されるすべての API が一覧表示されます。

olp api list [command options]

オプションのパラメータ :

• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --json コマンドの結果を JSON 形式で表示します。
• --quiet 新しい行にベース URL を表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

以下のコマンドは、使用可能なすべての API を一覧表示します。

olp api list --json

出力 :

{
    "apis": [
        {
            "baseURL": "https://account.api.here.com",
            "api": "account",
            "version": "v1",
            "parameters": {}
        },
        {
            "baseURL": "https://artifact.api.platform.here.com/v1",
            "api": "artifact",
            "version": "v1",
            "parameters": {}
        },
        {
            "baseURL": "https://config.data.api.platform.here.com/config/v1",
            "api": "config",
            "version": "v1",
            "parameters": {}
        },
        {
            "baseURL": "https://api-lookup.data.api.platform.here.com/lookup/v1",
            "api": "lookup",
            "version": "v1",
            "parameters": {}
        },
        {
            "baseURL": "https://marketplace.api.platform.here.com/api/v1",
            "api": "marketplace",
            "version": "v1",
            "parameters": {}
        },
        {
            "baseURL": "https://pipelines.api.platform.here.com/pipeline-service",
            "api": "pipelines",
            "version": "v2",
            "parameters": {}
        }
    ]
}