API call specifications for maps

This article provides API details for the maps service in the Cortex CMS.

Introduction

The Cortex CMS provides a dedicated capability for creating interactive maps in your website or app. These can be built and edited in Cortex, and pulled in using APIs.

Maps API call constructs

Get all maps

💻

GET {base URL}/v1/clients/{clientId}/maps

In which:

{base URL} is the URL shown below, depending on environment used.

{clientId} is your client ID, assigned during onboarding.

Get an individual map

💻

GET {base URL}/v1/clients/{clientId}/maps/{mapId}

In which:

{base URL} and {clientId} are as described above.

{mapId} is the ID for the individual map required. This can be obtained from the Cortex platform, or from the 'all maps' API described above.

Get all map points for a given map

💻

GET {base URL}/v1/clients/{clientId}/maps/{mapId}/coordinates

In which:

{base URL}, {clientId}, and {mapId} are as described above.

Get an individual map point

💻

GET {base URL}/v1/clients/{clientId}/maps/{mapId}/coordinates/{coordinateId}

In which:

{base URL}, {clientId}, and {mapId} are as described above.

{coordinateId} is the ID for the individual map point required. This can be obtained from the Cortex platform, or from the APIs described above.

Get all map point types

💻

GET {base URL}/v1/clients/{clientId}/types

In which:

{base URL} and {clientId} are as described above.

Get an individual map point type

💻

GET {base URL}/v1/clients/{clientId}/types/{typeId}

In which:

{base URL} and {clientId} are as described above.

{typeId} is the ID for the individual map point type required. This can be obtained from the Cortex platform, or from the APIs described above.