Получение списка продуктов

Метод используется для получения многостраничного списка продуктов реселлера (см. ), предназначенных для продажи и удовлетворяющих всем следующим требованиям:

Связанная категория продуктов опубликована (см. Получение списка категорий продуктов).
Продукт опубликован.
Этот продукт содержит хотя бы один опубликованный тарифный план.
Этот тарифный план имеет статус Активный.

Метод возвращает пустой массив, если у реселлера нет подходящих продуктов.

GET {reseller_domain}/internal_api/products

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

Авторизация

Требуется авторизация с помощью 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	Обязательный	Доменное имя реселлера
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)
filter[name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части названия продукта без учета регистра
filter[product_category_id]	query	integer	Опциональный	Предназначен для фильтрации списка по ID категории продуктов
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`. sort=priority — сортировка по возрастанию значений `priority`. sort=-priority — сортировка по убыванию значений `priority`.

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

Название				Тип данных	Описание
data				array of objects	Данные ответа
	id			string	ID продукта
	type			string	Тип данных
	attributes			object	Информация о продукте
		created_at			Дата и время создания продукта
		name			Название продукта
		product_category		object	Информация о связанной категории продуктов
			id	integer	ID категории продуктов
			name	string	Название категории продуктов
			logo	string	Ссылка на логотип категории продуктов
	priority			integer	Приоритет продукта
	brief_description			string	Краткое описание продукта
links				object	Ссылки для постраничной навигации
	self			string	Текущая страница
	first			string	Первая страница
	prev			string	Предыдущая страница (при наличии)
	next			string	Следующая страница (при наличии)
	last			string	Последняя страница
meta				object	Дополнительная информация
	current_page			integer	Номер текущей страницы
	page_count			integer	Общее число страниц
	server_current_time			string	Текущие дата и время сервера

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

Bash

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

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

JSON

{
    "data": [
        {
            "id": "15",
            "type": "products",
            "attributes": {
                "created_at": "2017-08-15T14:26:13.112024+0300",
                "name": "KAS",
                "product_category": {
                    "id": 129,
                    "name": "Klaspersky for business",
                    "logo": "https://storage.test.activeplatform.com/public/images/product_category/logo/129/Klaspersky-x3.png"
                },
                "priority": 0,
                "brief_description": "Klaspersky for business"
            }
        },
        {
            "id": "62",
            "type": "products",
            "attributes": {
                "created_at": "2017-09-01T09:56:05.523364+0300",
                "name": "KIS",
                "product_category": {
                    "id": 129,
                    "name": "Klaspersky for business",
                    "logo": "https://storage.test.activeplatform.com/public/images/product_category/logo/129/Klaspersky-x3.png"
                },
                "priority": 0,
                "brief_description": "Klaspersky for business"
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/internal_api/products?&page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "first": "https://test.activeplatform.com/internal_api/products?&page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "prev": null,
        "next": null,
        "last": "https://test.activeplatform.com/internal_api/products?&page%5Bnumber%5D=1&page%5Bsize%5D=50"
    },
    "meta": {
        "current_page": 1,
        "page_count": 1,
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}