Получение списка кастомных страниц

Метод используется для получения одностраничного списка кастомных страниц аккаунта, к которому есть доступ у текущего пользователя. В результате вызова метода платформа опрашивает каждый модуль на наличие кастомных страниц и их доступность для указанного аккаунта. В текущей версии поддержка кастомных страниц реализована только для модуля MicrosoftCSPProductsPlugin. Они используются для управления лицензиями и пользователями подписок Microsoft аккаунта.

GET {reseller_domain}/internal_api/custom_pages

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	query	integer	Обязательный	ID аккаунта, для которого запрашивается список кастомных страниц

Модель ответа

Название		Тип данных	Описание
data		array of objects	Данные ответа. Если указанному аккаунту не доступна ни одна кастомная страница, метод возвращает пустой массив
	plugin_slug	string	Ключ модуля, в котором есть кастомные страницы, доступные указанному аккаунту
	custom_page_key	string	Ключ кастомной страницы, доступной указанному аккаунту
meta		object	Дополнительная информация
	server_current_time	string	Текущие дата и время сервера

Пример запроса

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/custom_pages?account_id=1938' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON

{
    "data": [
        {
            "plugin_slug": "microsoft_csp_products",
            "custom_page_key": "microsoft_licenses_usage"
        },
        {
            "plugin_slug": "microsoft_csp_products",
            "custom_page_key": "microsoft_users_licenses"
        }
    ],
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}