How to get information about platform APIs

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

📘

Note

The api-lookup service is a platform service used exclusively with the Data API. For more information on using the Data API, see the Data API - Developer Guide.

How to get a list of all platform APIs

To get a list of all platform APIs, follow these steps:

1. Obtain an OAuth token. For instructions on how to obtain an OAuth token, see the Identity & Access Management Guide.
2. Send the following 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": {}
    }
]

How to get the base URL and parameters for a platform API

You can get the base URL and parameters for a platform API if you know the API name and version. To get the base URL and parameters for a platform API, follow these steps:

1. Obtain an OAuth token. For instructions on how to obtain an OAuth token, see the Identity & Access Management Guide.
2. Get a list of API names and versions, as needed. For more information, see the previous procedure Get a list of all platform APIs.
3. Send the following 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, send the following 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