Get Platform APIs

Platform APIs are those that do not act on existing objects but rather provide platform-level services. For example, the API to create a catalog is a platform API.

Get All Platform APIs

To get a list of all platform APIs:

  1. Obtain an authorization token. For instructions, see the Authentication and Authorization Developer's Guide.
  2. Use this REST request:

    GET /lookup/v1/platform/apis HTTP/1.1
    Host: api-lookup.data.api.platform.here.com
    Authorization: Bearer <Authorization Token>
    Cache-Control: no-cache
    

The response is a list of all versions of all platform APIs that you have access to. For example:

[
    {
        "api": "config",
        "version": "v1",
        "baseURL": "<Base URL for Config service>",
        "parameters": {}
    },
    {
        "api": "pipelines",
        "version": "v1",
        "baseURL": "<Base URL for Pipelines service>",
        "parameters": {}
    }
]

Get a Platform API

You can get the base URL and parameters for a single platform API if you know the API name and version.

  1. Obtain an authorization token. For instructions, see the Authentication and Authorization Developer's Guide.
  2. To get a list of API names and versions, see Get All Platform APIs.
  3. Use this REST request:

    GET /lookup/v1/platform/apis/<API Name>/<Version> HTTP/1.1
    Host: api-lookup.data.api.platform.here.com
    Authorization: Bearer <Authorization Token>
    Cache-Control: no-cache
    

For example, to get information about the config API, version 1, you would send this request:

GET /lookup/v1/platform/apis/config/v1 HTTP/1.1
Host: api-lookup.data.api.platform.here.com
Authorization: Bearer <Authorization Token>
Cache-Control: no-cache

results matching ""

    No results matching ""