API call specifications for navigation menus
This article explains how Cortex provides dedicated navigation menu options for your app or website. It presents the API calls for the navigation service.
Introduction
Cortex provides a dedicated capability for creating navigation bars and menus for your website. These can be built and edited in Cortex, and pulled in using APIs. The fields for the API calls are set within Cortex, so this document first runs through the API call constructs and then goes through the options and fields as they can be set by the creator within Cortex.
Navigation menu API call constructs
Fetch all navigation menus
Below is the API call to fetch all navigation menus.
GET
{environment-id}/v1/clients/{clientID}/navigations
In which:
{environment-id} is the URL shown below, depending on environment used.
- Standard environment: https://navigation.cortextech.io
- US environment: https://navigation.cortextech.us
{clientId} is your client ID, assigned during onboarding.
For example:
GET
https://navigation.cortextech.io/v1/clients/DEMO/navigations
Fetch a navigation menu by ID
Below is the API call to fetch an individual navigation menu.
GET
{environment-id}/v1/clients/{clientID}/navigations/{navigationID}
In which:
{environment-id} and {clientId} are as described above.
{navigationID} is the unique ID for the navigation object you require. This ID can be obtained from the Cortex platform.
For example:
GET
https://navigation.cortextech.io/v1/clients/DEMO/navigations/66bcd25e9615794e009b6e35
Fetch all navigation menus in a category
GET
{environment-id}/v1/clients/{client-id}/navigations?categoryIds={category-id}
In which:
{environment-id} and {client-id} are as described above.
{category-id} is the ID of a category created and assigned to a navigation menu in Cortex. Using this filter will return only the navigation menus assigned that category. Multiple categories can be specified by using a comma-delimited list of category IDs. Where multiple category IDs are added, the endpoint returns navigation menus with at least one of those category IDs.
For example, the following call would navigation menus in the client DEMO, with either or both of the categories with IDs 1234 or 5678.
GET
https://navigation.cortextech.io/v1/clients/DEMO/navigations?categoryIds=1234,5678
Updated about 1 month ago