Получение информации о продукте

Метод Get product используется для получения информации о продукте выбранного или нижестоящего реселлера.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

Роль и уровень доступа менеджера, от которых зависит доступность метода.
Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/products/{product_id}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/
Опциональный

Описание

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

integer

Обязательный

ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

product_id

path

integer

Обязательный

ID продукта

plan_currency

query

bool

Опциональный

Используется для отображения цен продукта в валюте тарифного плана (см. также Управление валютой Customer Store):

true — все цены в рамках каждого тарифного плана отображаются в валюте этого тарифного плана.
false — все цены отображаются в валюте реселлера (по умолчанию). Если валюта тарифного плана отличается от валюты реселлера, цены пересчитываются по текущему курсу (см. Управление курсами валют).

include

query

string

Опциональный

Предназначен для включения в ответ дополнительной информации о связанных объектах. Для получения информации о нескольких объектах значения параметра должны перечисляться через запятую. Поддерживаются следующие объекты:

Объект	Значение параметра
Вендор	`vendor`
Продуктовая линейка	`product_line`

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

Название Тип данных Описание

data object Данные ответа

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

Признак доступности продукта через Витрину:

true — продукт опубликован и отображается в Витрине.
false — продукт не опубликован и не отображается в Витрине.

priority integer Приоритет продукта (см. Создание продукта)

plans array of objects Информация о тарифных планах в рамках продукта

created_at

date

Дата и время создания тарифного плана

updated_at

date

Дата и время последнего обновления тарифного плана

id integer ID тарифного плана

status string Статус тарифного плана (список статусов см. в Просмотр списка тарифных планов)

name string Название тарифного плана

description string Дополнительная информация о тарифном плане, которая отображается клиентам в Панели управления Клиента

sku string SKU тарифного плана

public

bool

Признак доступности тарифного плана:

true — тарифный план доступен для заказа.
false — тарифный план недоступен для заказа.

plan_class string Название правила предоставления (см. Управление правилами предоставления тарифных планов)

plan_class_id integer ID правила предоставления

billing_type string Тип биллинга тарифного плана (см. Списания по подпискам с различными типами биллинга)

singleton

bool

Признак Единичный тарифного плана:

true — клиент может иметь только одну подписку на этот тарифный план.
false — клиент может иметь неограниченное количество подписок на этот тарифный план.

fixed_price

bool

Признак Фиксированная цена тарифного плана:

true — клиент получает возможность оплачивать подписку и заказывать дополнительные ресурсы по фиксированной цене, которая была установлена в тарифном плане на момент заказа подписки. Новая стоимость будет применена к подписке только после ее продления.
false — цены тарифного плана не фиксируются.

auto_renewal

bool

Состояние опции Автопродление по умолчанию для подписок на этот тарифный план:

true — опция Автопродление включена.
false — опция Автопродление выключена.

currency object Информация о валюте, в которой указаны цены данного тарифного плана. Валюта определяется значением параметра plan_currency в запросе

precision integer Количество десятичных знаков (доля базовой денежной единицы для разменной денежной единицы валюты. Например, для копеек и центов: 2)

unit string Обозначение валюты

separator string Десятичный разделитель

delimiter string Разделитель разрядов целой части

format

string

Порядок отображения суммы в валюте и ее единиц, где:

%n — сумма в валюте.
%u — единица валюты.

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

Единицы измерения ресурса:

unit — измеряемый ресурс, для которого указывается определенное количество.
boolean — неизмеряемый ресурс (для ресурсов, у которых не надо указывать количество), возможные значения:
- true — ресурс включен в тарифный план.
- false — ресурс не включен в тарифный план.

status

string

Статус ресурса:

active — активный.
inactive — неактивный.
deleted — удален.

included integer Количество ресурса, которое включено в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки)

minimum integer Минимальное количество ресурса (с учетом величины included), которое доступно для заказа (см. Ресурсы тарифного плана)

limit integer Максимальное количество ресурса, доступное для заказа. Если ресурс безлимитный (признак unlimited = true), то limit = 0

public

bool

Возможные значения:

true — ресурс доступен клиентам для заказа.
false — ресурс недоступен клиентам для заказа.

unlimited

bool

Признак отключения лимитов использования ресурса:

true — лимиты отключены.
false — лимиты активны.

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

Признак того, является ли период тарифного плана бессрочным:

true — период является бессрочным.
false — период не является бессрочным. Продолжительность периода указана в durations.

trial

bool

Признак того, является ли период тарифного плана пробным:

true — период является пробным.
false — период не является пробным.

public

bool

Признак доступности периода для заказа в рамках данного тарифного плана:

true — период доступен для заказа.
false — период недоступен для заказа.

status

string

Статус периода тарифного плана:

active — активный.
deleted — удален.

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 Номер телефона технической поддержки продукта

email string Email технической поддержки продукта

url string Ссылка на страницу для создания запроса в техническую поддержку продукта

details string Дополнительная информация о технической поддержке продукта

market object Маркетинговая информация о продукте для Витрины (вкладка Маркетинг в статье Создание продукта)

created_at

date

Дата и время создания маркетинговой информации о продукте

updated_at

date

Дата и время последнего обновления маркетинговой информации о продукте

name string Маркетинговое название продукта

description string Маркетинговое описание продукта

brief_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 Ссылка на файл логотипа продукта

relationships object Информация о связанных объектах

vendor object Информация о связанном вендоре

data object Информация о вендоре

id string ID вендора

type string Тип данных

product_line object Информация о связанной продуктовой линейке

data object Информация о продуктовой линейке

id string ID продуктовой линейки

type string Тип данных

included

array of objects

Дополнительная информация о связанных объектах, указанных в запросе:

Название	Тип данных	Описание
id	string	ID объекта
type	string	Тип данных
attributes	object	Атрибуты (состав данных см. ниже)

Для вендора (см. Вендоры):

Название	Тип данных	Описание
created_at	string	Дата и время создания вендора
updated_at	string	Дата и время последнего изменения вендора
name	string	Название вендора
logo	string	Ссылка на логотип вендора

Для продуктовой линейки (см. Продуктовые линейки):

Название	Тип данных	Описание
created_at	string	Дата и время создания продуктовой линейки
updated_at	string	Дата и время последнего изменения продуктовой линейки
name	string	Название продуктовой линейки

meta object Дополнительные данные ответа

currency string Код валюты реселлера ISO 4217 alpha-3

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

GET /api/v3/customer_store/resellers/1/products/1
Host: https://test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

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

{
    "data": {
        "id": "1",
        "type": "products",
        "attributes": {
            "created_at": "2022-12-21T13:04:37.202Z",
            "updated_at": "2023-02-14T13:02:26.512Z",
            "name": "Product 1",
            "category": {
                "data": {
                    "id": "1",
                    "type": "product_categories",
                    "attributes": {
                        "created_at": "2022-12-21T13:04:03.099Z",
                        "updated_at": "2022-12-21T13:04:03.099Z",
                        "key": "123",
                        "name": "Category1",
                        "description": "",
                        "priority": 0,
                        "public": false,
                        "logo": null
                    }
                }
            },
            "description": "",
            "public": false,
            "license_agreement": null,
            "privacy_policy": null,
            "priority": 0,
            "plans": [
                {
                    "created_at": "2023-02-01T13:53:37.593Z",
                    "updated_at": "2023-02-01T13:55:05.811Z",
                    "id": 1205,
                    "status": "active",
                    "name": "office 365",
                    "description": "",
                    "sku": "",
                    "public": true,
                    "plan_class": "Default(external system)",
                    "plan_class_id": 1,
                    "billing_type": "csp_monthly",
                    "singleton": false,
                    "fixed_price": false,
                    "auto_renewal": false,
                    "currency": {
                        "precision": 2,
                        "unit": "€",
                        "separator": ".",
                        "delimiter": " ",
                        "format": "%n %u",
                        "iso_code": "EUR"
                    },
                    "resources": [
                        {
                            "created_at": "2023-02-01T13:56:34.176Z",
                            "updated_at": "2023-02-01T13:56:34.176Z",
                            "id": 1251,
                            "name": "Licences count",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 0,
                            "limit": 1500,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "0.0",
                                "overuse": "0.0",
                                "recurring": "10.0",
                                "renewal": "0.0"
                            }
                        }
                    ],
                    "periods": [
                        {
                            "created_at": "2023-02-01T13:55:05.806Z",
                            "updated_at": "2023-02-01T13:55:05.806Z",
                            "id": 1210,
                            "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": "2023-01-16T11:54:54.420Z",
                    "updated_at": "2023-01-16T11:55:39.310Z",
                    "id": 1010,
                    "status": "active",
                    "name": "Perpetual",
                    "description": "",
                    "sku": "",
                    "public": true,
                    "plan_class": "Default(external system)",
                    "plan_class_id": 1,
                    "billing_type": "non_recurring",
                    "singleton": false,
                    "fixed_price": false,
                    "auto_renewal": false,
                    "currency": {
                        "precision": 2,
                        "unit": "€",
                        "separator": ".",
                        "delimiter": " ",
                        "format": "%n %u",
                        "iso_code": "EUR"
                    },
                    "resources": [
                        {
                            "created_at": "2023-01-16T11:55:39.280Z",
                            "updated_at": "2023-01-16T11:55:39.280Z",
                            "id": 1057,
                            "name": "SQL Server 2022 Enterprise - 2 Core License Pack - 1 year",
                            "key": null,
                            "unit_of_measure": "unit",
                            "status": "active",
                            "included": 0,
                            "minimum": 0,
                            "limit": 1500,
                            "public": true,
                            "unlimited": false,
                            "fees": {
                                "setup": "10.0",
                                "overuse": "0.0",
                                "recurring": "0.0",
                                "renewal": "5.0"
                            }
                        }
                    ],
                    "periods": [
                        {
                            "created_at": "2023-01-16T11:55:39.301Z",
                            "updated_at": "2023-01-16T11:55:39.301Z",
                            "id": 1015,
                            "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"
                            }
                        }
                    ]
                }
            ],
            "support": {
                "phone": "",
                "email": "",
                "url": "",
                "details": ""
            },
            "market": {
                "created_at": "2022-12-21T13:04:56.966Z",
                "updated_at": "2022-12-21T13:04:56.966Z",
                "name": "Solution",
                "description": "SQL Server 2022 Enterprise",
                "brief_description": "SQL Server 2022 Enterprise",
                "screenshots": [],
                "video_url": [],
                "documentation_url": [],
                "benefits": [],
                "image": null
            }
        },
        "relationships": {
            "vendor": {
                "data": {
                    "id": "15",
                    "type": "vendors"
                }
            },
            "product_line": {
                "data": {
                    "id": "6",
                    "type": "product_lines"
                }
            }
        }
    },
    "meta": {
        "currency": "USD"
    }
}