Получение списка продуктов реселлера
Метод Get list of products используется для получения списка всех продуктов, существующих у выбранного или нижестоящего реселлера.
Для авторизации требуется API-токен сотрудника. API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/productsАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
| Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
| Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
| base_url | path | string | Обязательный | URL ActivePlatform |
reseller_id | path | number | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) |
per_page | query | number | Опциональный | Параметр постраничной навигации |
page | query | number | Опциональный | Параметр постраничной навигации. Номер страницы ответа |
sorting[field] | query | string | Опциональный | Сортировка списка по указанному полю |
sorting[reversed] | query | bool | Опциональный | Установка режима обратной сортировки по указанному полю:
|
filters[type] | query | string | Опциональный | Фильтрация списка по типу продукта |
filters[category] | query | string | Опциональный | Фильтрация списка по названию категории продуктов |
filters[public] | query | bool | Опциональный | Фильтрация списка по признаку |
| plan_currency | query | bool | Опциональный | Используется для отображения цен в продуктах в валюте тарифного плана (см. также Управление валютой Customer Store):
|
Модель ответа
| Название | Тип данных | Описание | |||||
|---|---|---|---|---|---|---|---|
| data | array of objects | Данные ответа | |||||
id | integer | ID продукта | |||||
| type | string | Тип данных | |||||
| attributes | object | Информация о продукте | |||||
created_at | date | Дата и время создания продукта | |||||
updated_at | date | Дата и время последнего обновления продукта | |||||
| name | string | Название продукта | |||||
| type | string | Тип продукта | |||||
| category | object | Категория продуктов | |||||
| data | object | Данные категории продуктов (см. Создание категории продуктов) | |||||
| id | integer | ID категории продуктов | |||||
| type | string | Тип данных | |||||
| attributes | object | Информация о категории продуктов | |||||
created_at | date | Дата и время создания категории продуктов | |||||
updated_at | date | Дата и время последнего обновления категории продуктов | |||||
| key | string | Ключ категории продуктов | |||||
| name | string | Название категории продуктов | |||||
| description | string | Описание категории продуктов | |||||
| priority | integer | Приоритет категории продуктов | |||||
| logo | string | Ссылка на файл логотипа категории продуктов | |||||
| description | string | Описание продукта | |||||
| license-agreement | string | Ссылка на лицензионное соглашение продукта | |||||
| privacy-policy | string | Ссылка на политику конфиденциальности при использовании продукта | |||||
| public | bool | Признак доступности продукта через Витрину:
| |||||
| vendor | object | Информация о вендоре | |||||
| name | string | Название вендора | |||||
| logo | string | Ссылка на файл логотипа вендора | |||||
| plans | array of objects | Информация о тарифных планах в рамках продукта | |||||
created_at | date | Дата и время создания тарифного плана | |||||
updated_at | date | Дата и время последнего обновления тарифного плана | |||||
| id | integer | ID тарифного плана | |||||
| status | string | Статус тарифного плана (список статусов см. в Просмотр списка тарифных планов) | |||||
| name | string | Название тарифного плана | |||||
| description | string | Дополнительная информация о тарифном плане, которая отображается клиентам в Панели управления клиента | |||||
| sku | string | SKU тарифного плана | |||||
| public | bool | Признак доступности тарифного плана:
| |||||
| plan_class | string | Название правила предоставления (см. Управление правилами предоставления тарифных планов) | |||||
| plan_class_id | integer | ID правила предоставления | |||||
| billing_type | string | Тип биллинга тарифного плана | |||||
| singleton | bool | Признак Единичный тарифного плана:
| |||||
| fixed_price | bool | Признак Фиксированная цена тарифного плана:
| |||||
| auto_renewal | bool | Состояние опции Автопродление по умолчанию для подписок на этот тарифный план:
| |||||
| currency | object | Информация о валюте, в которой указаны цены данного тарифного плана. Валюта определяется значением параметра plan_currency в запросе | |||||
| precision | integer | Количество десятичных знаков (доля базовой денежной единицы для разменной денежной единицы валюты. Например, для копеек и центов: 2) | |||||
| unit | string | Обозначение валюты | |||||
| separator | string | Десятичный разделитель | |||||
| delimiter | string | Разделитель разрядов целой части | |||||
| format | string | Порядок отображения суммы в валюте и ее единиц, где:
| |||||
| iso_code | string | Код валюты ISO 4217 alpha-3 | |||||
| resources | array of objects | Информация о ресурсах тарифного плана | |||||
created_at | date | Дата и время создания ресурса | |||||
updated_at | date | Дата и время последнего обновления ресурса | |||||
| id | integer | ID ресурса | |||||
| name | string | Название ресурса | |||||
| key | string | Ключ ресурса | |||||
| unit_of_measure | string | Единицы измерения ресурса:
| |||||
| status | string | Статус ресурса:
| |||||
| included | integer | Количество ресурса, которое включено в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки) | |||||
| minimum | integer | Минимальное количество ресурса (с учетом величины included), которое доступно для заказа (см. Ресурсы тарифного плана) | |||||
| limit | integer | Максимальное количество ресурса, доступное для заказа. Если ресурс безлимитный (признак unlimited = true), то limit = 0 | |||||
| public | bool | Возможные значения:
| |||||
| unlimited | bool | Признак отключения лимитов использования ресурса:
| |||||
| fees | object | Информация о стоимостях ресурса | |||||
| setup | float | Величина платежа за установку ресурса | |||||
| overuse | float | Стоимость перерасхода ресурсов | |||||
| recurring | float | Величина ежемесячной абонентской платы за ресурс | |||||
| renewal | float | Стоимость продления использования ресурса | |||||
| periods | array of objects | Информация о периодах тарифного плана | |||||
created_at | date | Дата и время создания периода тарифного плана | |||||
updated_at | date | Дата и время последнего обновления периода тарифного плана | |||||
| id | integer | ID периода тарифного плана | |||||
| endless | bool | Признак того, является ли период тарифного плана бессрочным:
| |||||
| trial | bool | Признак того, является ли период тарифного плана пробным:
| |||||
| public | bool | Признак доступности периода для заказа в рамках данного тарифного плана:
| |||||
| status | string | Статус периода тарифного плана:
| |||||
| description | string | Описание периода тарифного плана | |||||
| durations | object | Информация о длительности периода тарифного плана | |||||
| value | integer | Длительность периода тарифного плана. Если период бессрочный, то value = null | |||||
| type | string | Единица измерения периода тарифного плана. Если период бессрочный, то type = null | |||||
| fees | object | Информация о стоимостях периода | |||||
| setup | float | Величина платежа за установку тарифного плана для данного периода | |||||
| recurring | float | Величина ежемесячной абонентской платы за период | |||||
| transfer | float | Стоимость переноса домена, если услугa включает в себя возможность использования доменов | |||||
| renewal | float | Стоимость продления тарифного плана для данного периода | |||||
| support | object | Информация о технической поддержке продукта | |||||
| phone | string | Номер телефона технической поддержки продукта | |||||
| string | Email технической поддержки продукта | ||||||
| url | string | Ссылка на страницу для создания запроса в техническую поддержку продукта | |||||
| details | string | Дополнительная информация о технической поддержке продукта | |||||
| market | object | Маркетинговая информация о продукте для Витрины (вкладка Маркетинг в статье Создание продукта) | |||||
created_at | date | Дата и время создания маркетинговой информации о продукте | |||||
updated_at | date | Дата и время последнего обновления маркетинговой информации о продукте | |||||
| name | string | Маркетинговое название продукта | |||||
| description | string | Маркетинговое описание продукта | |||||
| screenshots | array of objects | Информация о снимках экрана продукта | |||||
| title | string | Название снимка экрана | |||||
| url | string | Ссылка на снимок экрана | |||||
| video_url | array of objects | Информация о видео продукта | |||||
| title | string | Название видео | |||||
| url | string | Ссылка на видео | |||||
| documentation_url | array of objects | Информация о документации продукта | |||||
| title | string | Название документа | |||||
| url | string | Ссылка на документ | |||||
| benefits | array of objects | Информация о преимуществах продукта | |||||
| title | string | Название преимущества | |||||
| description | string | Описание преимущества | |||||
| image | string | Ссылка на файл логотипа продукта | |||||
| links | object | Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации | |||||
| self | string | Ссылка на текущую страницу | |||||
| first | string | Ссылка на первую страницу | |||||
| prev | string | Ссылка на предыдущую страницу | |||||
| next | string | Ссылка на следующую страницу | |||||
| last | string | Ссылка на последнюю страницу | |||||
| meta | object | Дополнительные данные ответа | |||||
| currency | string | Код валюты реселлера ISO 4217 alpha-3 | |||||
| pages | object | Информация о страницах ответа | |||||
| current | integer | Номер текущей страницы | |||||
| prev | integer | Номер предыдущей страницы | |||||
| has_prev | bool | Наличие предыдущей страницы:
| |||||
| next | integer | Номер следующей страницы | |||||
| has_next | bool | Наличие следующей страницы:
| |||||
| total | integer | Общее число страниц | |||||
Пример запроса
GET /api/v3/customer_store/resellers/1/products?per_page=2&filters[public]=false&sorting[field]=updated_at&sorting[reversed]=true
Host: https://test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonПример ответа
{
"data": [
{
"id": "878",
"type": "products",
"attributes": {
"created_at": "2020-06-17T13:59:15.810+03:00",
"updated_at": "2020-09-23T15:07:17.734+03:00",
"name": "G Suite for migration",
"type": "saas",
"category": {
"data": {
"id": "190",
"type": "product_categories",
"attributes": {
"created_at": "2017-09-14T16:27:16.566+03:00",
"updated_at": "2020-03-11T10:46:45.422+03:00",
"key": "default",
"name": "default",
"description": "",
"priority": 0,
"logo": null
}
}
},
"description": "",
"license_agreement": null,
"privacy_policy": null,
"public": false,
"vendor": {
"name": "G Suite magration",
"logo": null
},
"plans": [
{
"created_at": "2020-06-17T13:59:16.031+03:00",
"updated_at": "2020-06-17T13:59:16.409+03:00",
"id": 1863,
"status": "active",
"name": "G Suite Basic годовой план с помесячной оплатой",
"description": "G Suite Basic – это пакет приложений для совместной работы, который включает корпоративную почту, общие календари, сервисы для редактирования и хранения документов в Интернете, инструменты для видеоконференций и многое другое.",
"sku": null,
"public": false,
"plan_class": "gsuitemigration",
"plan_class_id": 13078,
"billing_type": "csp_monthly",
"singleton": false,
"fixed_price": false,
"auto_renewal": false,
"currency": {
"precision": 2,
"unit": "руб.",
"separator": ".",
"delimiter": " ",
"format": "%n %u",
"iso_code": "RUB"
},
"resources": [
{
"created_at": "2020-06-17T13:59:16.108+03:00",
"updated_at": "2020-06-17T13:59:16.108+03:00",
"id": 4742,
"name": "Пользователь",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 0,
"minimum": 1,
"limit": 750,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "2.65",
"renewal": "0.0"
}
},
{
"created_at": "2020-06-17T13:59:16.154+03:00",
"updated_at": "2020-06-17T13:59:16.154+03:00",
"id": 4744,
"name": "Предоставление доступа к сервисам Google Drive storage Upgrade 8TB на 1 учетную запись, на 1 месяц",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 0,
"minimum": 0,
"limit": 750,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "9.6",
"renewal": "0.0"
}
},
{
"created_at": "2020-06-17T13:59:16.326+03:00",
"updated_at": "2020-06-17T13:59:16.326+03:00",
"id": 4752,
"name": "Предоставление доступа к сервисам Google Vault на 1 учетную запись, на 1 месяц",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 0,
"minimum": 0,
"limit": 750,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "6.2",
"renewal": "0.0"
}
}
],
"periods": [
{
"created_at": "2020-06-17T13:59:16.360+03:00",
"updated_at": "2020-06-17T13:59:16.360+03:00",
"id": 3278,
"endless": false,
"trial": false,
"public": true,
"status": "active",
"description": null,
"durations": {
"value": 1,
"type": "year"
},
"fees": {
"setup": "0.0",
"recurring": "0.0",
"transfer": "0.0",
"renewal": "0.0"
}
}
]
},
{
"created_at": "2020-06-17T13:59:16.418+03:00",
"updated_at": "2020-06-17T13:59:16.880+03:00",
"id": 1864,
"status": "active",
"name": "G Suite Basic гибкий план",
"description": "G Suite Basic – это пакет приложений для совместной работы, который включает корпоративную почту, общие календари, сервисы для редактирования и хранения документов в Интернете, инструменты для видеоконференций и многое другое.",
"sku": null,
"public": false,
"plan_class": "gsuitemigration",
"plan_class_id": 13078,
"billing_type": "csp_monthly",
"singleton": false,
"fixed_price": false,
"auto_renewal": false,
"currency": {
"precision": 2,
"unit": "руб.",
"separator": ".",
"delimiter": " ",
"format": "%n %u",
"iso_code": "RUB"
},
"resources": [
{
"created_at": "2020-06-17T13:59:16.820+03:00",
"updated_at": "2020-06-17T13:59:16.820+03:00",
"id": 4763,
"name": "Пользователь",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 0,
"minimum": 1,
"limit": 750,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "6.2",
"renewal": "0.0"
}
},
{
"created_at": "2020-06-17T13:59:16.472+03:00",
"updated_at": "2020-06-17T13:59:16.472+03:00",
"id": 4754,
"name": "Предоставление доступа к сервисам Google Drive storage Upgrade 8TB на 1 учетную запись, на 1 месяц",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 0,
"minimum": 0,
"limit": 750,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "9.6",
"renewal": "0.0"
}
},
{
"created_at": "2020-06-17T13:59:16.800+03:00",
"updated_at": "2020-06-17T13:59:16.800+03:00",
"id": 4762,
"name": "Предоставление доступа к сервисам Google Vault на 1 учетную запись, на 1 месяц",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 0,
"minimum": 0,
"limit": 750,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "6.2",
"renewal": "0.0"
}
}
],
"periods": [
{
"created_at": "2020-06-17T13:59:16.857+03:00",
"updated_at": "2020-06-17T13:59:16.857+03:00",
"id": 3280,
"endless": false,
"trial": false,
"public": true,
"status": "active",
"description": null,
"durations": {
"value": 1,
"type": "month"
},
"fees": {
"setup": "0.0",
"recurring": "0.0",
"transfer": "0.0",
"renewal": "0.0"
}
},
{
"created_at": "2020-06-17T13:59:16.838+03:00",
"updated_at": "2020-06-17T13:59:16.838+03:00",
"id": 3279,
"endless": true,
"trial": false,
"public": true,
"status": "active",
"description": null,
"durations": {
"value": null,
"type": null
},
"fees": {
"setup": "0.0",
"recurring": "0.0",
"transfer": "0.0",
"renewal": "0.0"
}
}
]
}
],
"support": {
"phone": "",
"email": "",
"url": "",
"details": ""
},
"market": {
"created_at": "2020-06-17T13:59:16.939+03:00",
"updated_at": "2021-04-08T10:43:58.165+03:00",
"name": "G Suite migration",
"description": "Пакет облачных служб и приложений для совместной работы по подписке. В пакет входят популярные веб-приложения Google в том числе Gmail, Google Диск, Google Hangouts, Google Календарь и Google Документы. Помимо этого, они предоставляют дополнительные возможности для корпоративных клиентов, такие как адреса Электронной почты в домене компании, 30 ГБ и более для хранения писем и документов, а также круглосуточная поддержка по телефону и электронной почте. Поскольку Google Suite является облачным решением, то все пользовательские данные хранятся в защищенных дата-центрах Google, а не на локальных серверах клиента, как при использовании стандартного специализированного ПО.",
"screenshots": [],
"video_url": [],
"documentation_url": [
{
"title": "",
"url": "https://docs.activeplatform.com/"
}
],
"benefits": [],
"image": null
}
}
},
{
"id": "843",
"type": "products",
"attributes": {
"created_at": "2020-03-12T16:27:35.321+03:00",
"updated_at": "2020-03-12T16:27:35.321+03:00",
"name": "Облако VMware",
"type": "iaas",
"category": {
"data": {
"id": "190",
"type": "product_categories",
"attributes": {
"created_at": "2017-09-14T16:27:16.566+03:00",
"updated_at": "2020-03-11T10:46:45.422+03:00",
"key": "default",
"name": "default",
"description": "",
"priority": 0,
"logo": null
}
}
},
"description": null,
"license_agreement": null,
"privacy_policy": null,
"public": false,
"vendor": {
"name": "Dev Company",
"logo": null
},
"plans": [
{
"created_at": "2020-03-12T16:27:35.572+03:00",
"updated_at": "2020-03-12T16:27:35.975+03:00",
"id": 1785,
"status": "active",
"name": "VCD22222",
"description": "",
"sku": null,
"public": false,
"plan_class": "11111",
"plan_class_id": 12785,
"billing_type": "reservation",
"singleton": false,
"fixed_price": true,
"auto_renewal": false,
"currency": {
"precision": 2,
"unit": "руб.",
"separator": ".",
"delimiter": " ",
"format": "%n %u",
"iso_code": "RUB"
},
"resources": [
{
"created_at": "2020-03-12T16:27:35.799+03:00",
"updated_at": "2020-03-12T16:27:35.799+03:00",
"id": 4555,
"name": "vCPU",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 2,
"minimum": 2,
"limit": 128,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "9.0",
"renewal": "0.0"
}
},
{
"created_at": "2020-03-12T16:27:35.831+03:00",
"updated_at": "2020-03-12T16:27:35.831+03:00",
"id": 4556,
"name": "vRAM",
"key": null,
"unit_of_measure": "unit",
"status": "active",
"included": 4,
"minimum": 4,
"limit": 2048,
"public": true,
"unlimited": false,
"fees": {
"setup": "0.0",
"overuse": "0.0",
"recurring": "5.0",
"renewal": "0.0"
}
}
],
"periods": [
{
"created_at": "2020-03-12T16:27:35.921+03:00",
"updated_at": "2020-03-12T16:27:35.921+03:00",
"id": 3114,
"endless": false,
"trial": false,
"public": true,
"status": "active",
"description": null,
"durations": {
"value": 1,
"type": "month"
},
"fees": {
"setup": "0.0",
"recurring": "0.0",
"transfer": "0.0",
"renewal": "0.0"
}
},
{
"created_at": "2020-03-12T16:27:35.960+03:00",
"updated_at": "2020-03-12T16:27:35.960+03:00",
"id": 3115,
"endless": false,
"trial": true,
"public": true,
"status": "active",
"description": null,
"durations": {
"value": 1,
"type": "month"
},
"fees": {
"setup": "0.0",
"recurring": "0.0",
"transfer": "0.0",
"renewal": "0.0"
}
}
]
}
],
"support": {
"phone": "+1(555) 555-5555",
"email": "info@example.com",
"url": "",
"details": ""
},
"market": {
"created_at": "2020-03-12T16:27:36.044+03:00",
"updated_at": "2020-03-12T16:27:36.044+03:00",
"name": "Облако VMware",
"description": "",
"screenshots": [],
"video_url": [],
"documentation_url": [],
"benefits": [],
"image": null
}
}
}
],
"links": {
"self": "https://test.activeplatform.com/api/v3/customer_store/resellers/1/products?filters%5Bpublic%5D=false&page%5Bnumber%5D=1&page%5Bsize%5D=2&per_page=2&sorting%5Bfield%5D=updated_at&sorting%5Breversed%5D=true",
"first": "https://test.activeplatform.com/api/v3/customer_store/resellers/1/products?filters%5Bpublic%5D=false&page%5Bnumber%5D=1&page%5Bsize%5D=2&per_page=2&sorting%5Bfield%5D=updated_at&sorting%5Breversed%5D=true",
"prev": null,
"next": "https://test.activeplatform.com/api/v3/customer_store/resellers/1/products?filters%5Bpublic%5D=false&page%5Bnumber%5D=2&page%5Bsize%5D=2&per_page=2&sorting%5Bfield%5D=updated_at&sorting%5Breversed%5D=true",
"last": "https://test.activeplatform.com/api/v3/customer_store/resellers/1/products?filters%5Bpublic%5D=false&page%5Bnumber%5D=26&page%5Bsize%5D=2&per_page=2&sorting%5Bfield%5D=updated_at&sorting%5Breversed%5D=true"
},
"meta": {
"currency": "RUB",
"pages": {
"current": 1,
"prev": 0,
"has_prev": false,
"next": 2,
"has_next": true,
"total": 26
}
}
}