API ワークフロー

HERE platform を使用すると、ユーザーは REST API を直接操作できます。 OLP CLI には、次のような REST API への直接コールを容易にするためのヘルパーツールが用意されています。

詳細については 、「 API コマンド」を参照してください。

次の手順では、 OLP CLI の機能を結合して、 REST API を取得し、 CURL によってREST API への直接のコールを持つエンドポイントのリストを取得し、プロジェクトスコープのトークンを使用して CURL を使用してアクセス トークンに直接コールする方法を示します。

API トークン を入手します

新しい API トークンを取得するには olp api token get 、コマンドを実行します。

olp api token get --json

コマンドを実行すると、次の結果が表示されます。

{
    "accessToken": "eyJhbG...LMXA",
    "expiresAt": "2019-03-07T10:56:51.329Z"
}

すべての API エンドポイントを一覧表示します

HERE platform によって提供されるすべてのエンドポイントを一覧表示するに olp api list は、コマンドを使用します。

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": {}
    }
]}

curl で REST API に電話をかけます

アクセス権のあるカタログを取得するには、次のコマンドを実行します。

注

以下の curl コマンドを実行するには、ダウンロードしてインストールしてください。


curl -k -s -H "Authorization: Bearer eyJhbG...LMXA" https://config.data.api.platform.here.com/config/v1/catalogs

これは olp catalog list 、コマンドの実行と同じです。

このコマンドは、次のような結果を表示します。


{
  "results": {
    "items": [
      {
        "title": "HERE - Sensor Sample Data",
        "hrn": "hrn:here:data::org:sensor-sample-data",
        "href": "https://config.data.api.platform.here.com/config/v1/catalogs/hrn:here:data::org:sensor-sample-data",
        "type": "urn:olp-types:catalog"
      },
      {
        "title": "HERE Live Weather Europe",
        "hrn": "hrn:here:data::org:live-weather-eu",
        "href": "https://config.data.api.platform.here.com/config/v1/catalogs/hrn:here:data::org:live-weather-eu",
        "type": "urn:olp-types:catalog"
      },
      {
        "title": "HERE Map Content",
        "hrn": "hrn:here:data::org:rib-2",
        "href": "https://config.data.api.platform.here.com/config/v1/catalogs/hrn:here:data::org:rib-2",
        "type": "urn:olp-types:catalog"
      }
    ]
  }
}

プラットフォームが提供する API の詳細については、Data API、Lookup API 、および パイプライン API を参照してください。

プロジェクトスコープの API トークン を取得します

プロジェクトのスコープを持つ新しい API トークンを取得するには、 --scope フラグを指定して olp api token get コマンドを実行します。

olp api token get --scope {{book.filtered.hrnPrefix}}:authorization::org:project/my-project --json

コマンドを実行すると、次の結果が表示されます。

{
    "accessToken": "eyJhbG...LMXA",
    "expiresAt": "2019-03-07T10:56:51.329Z"
}

プロジェクト範囲のトークン を使用して、 curl で REST API を呼び出します

プロジェクトに関連するカタログを取得するには、次のコマンドを実行します。


curl -k -s -H "Authorization: Bearer eyJhbG...LMXA" https://config.data.api.platform.here.com/config/v1/catalogs

このコマンドでは、プロジェクト内に作成されたカタログ、または API トークンの作成に使用したプロジェクトにリンクされたカタログがないため、空の結果が表示されます。


{
"results": {
    "items": []
    }
}

プロジェクト内にカタログを作成するには、 --scope フラグを指定して olp catalog create コマンドを使用します。 カタログをプロジェクトにリンクするには olp project resource link 、コマンドを使用します。

「」に一致する結果は 件です

    「」に一致する結果はありません