# API для паблишера :::caution Для доступа к [API](https://api.takprodam.ru/doc/publisher/redocly/) используйте API токен из личного профиля («Профиль» → «Общие настройки профиля» → «Генерация API токена»). ::: API — это инструмент, который позволяет: * оптимизировать работу с платформой Такпродам; * получать актуальную информацию о комиссиях, товарах, акциях, площадках; * эффективно управлять продвижением товаров и увеличивать доход. # Как работает API Вы отправляете со своего сервера HTTP-запрос типа GET к нашему API, чтобы получить нужную информацию из вашего кабинета. Мы принимаем запрос, обрабатываем его и отправляем ответ в формате JSON на ваш сервер. Для аутентификации запрос должен содержать уникальный токен из вашего личного профиля. # Методы (типы) запроса :::caution В запросах Get products list with links, Get promotions list и Get promotion products обязательно указывайте id вашей площадки. Получить id площадки можно через API-запрос Get source list. ::: ## Get commissions list Возвращает информацию о комиссиях. URL запроса — https://api.takprodam.ru/v2/publisher/commission/ ### Список параметров для запроса: | Название | Допустимое значение | | ----------------- | ------------------------------------------------------------------------------------------------------------------ | | id | id комиссии | | subid | Произвольный идентификатор, который вы можете использовать для дополнительной категоризации и отслеживания трафика | | status | Статус комиссии: | | | pending — в ожидании | | | approved — подтверждена | | | declined — отклонена | | payment\_type | Модель оплаты: | | | cpa — оплата за заказ | | | cpc — оплата за клик с учетом продаж (СРС с учетом продаж) | | | cpmc — оплата за переход по ссылке с витрины на товар (СРС с витриной) | | | hcpa — оплата за продажи и фиксированная комиссия при достижении порога по кликам (Гибридная CPA) | | created\_at\_from | Дата создания комиссии: начало периода | | created\_at\_to | Дата создания комиссии: конец периода | | updated\_at\_from | Дата обновления статуса комиссии: начало периода | | updated\_at\_to | Дата обновления статуса комиссии: конец периода | | page | Номер страницы | | limit | Число записей на странице (по умолчанию выбрано число 50; допустимое значение от 1 до 1000) | :::cut{title="Пример использования (разверните)"} Пример запроса с использованием утилиты curl ```plain -H "Host: api.takprodam.ru" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.takprodam.ru/v2/publisher/commission/?... \ --compressed ``` Пример ответа API-сервера в формате JSON ```plain { "total_count": 1000, "page": 1, "limit": 50, "items": [ { "id": "string", "payment_type": "cpa", "status": "pending", "commission_date": "2021-01-01", "source": { "id": 0, "title": "string", "status": "verification", "source_type": { "id": 0, "type": "social_network", "title": "string", "slug": "string" }, "source_url": "string", "created_at": "2019-08-24T14:15:22Z" }, "order_product": { "id": 0, "title": "string", "sku": "string" }, "click_product": { "id": 0, "title": "string", "sku": "string" }, "subid": "string", "marketplace": "ozon", "commission_amount": 0.1, "cart_amount": 0.1, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ] } ``` ::: ### Описание полей ответа API-сервера на Get commissions list | Поле | Описание | | ------------------ | ------------------------------------------------------------------------------------------------------------- | | id | Уникальный идентификатор комиссии | | payment\_type | Модель оплаты комиссии | | status | Текущий статус комиссии | | commission\_date | Дата регистрации комиссии | | source | Площадка | | order\_product | Информация о товаре, который заказан (только для Ozon) | | click\_product | Товар, по которому был совершен клик, приводящий к заказу (только для WB) | | subid | Дополнительный идентификатор для отслеживания источника трафика (если вы его указали при формировании ссылки) | | marketplace | Название маркетплейса | | commission\_amount | Размер комиссии | | cart\_amount | Сумма заказа | | created\_at | Дата и время заказа | | updated\_at | Дата и время последнего обновления статуса заказа | ## Get products list with links Возвращает информацию о товарах с партнерскими ссылками. URL запроса — https://api.takprodam.ru/v2/publisher/product/ ### Список параметров для запроса: | Название | Допустимое значение | | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | source\_id | id площадки (узнать id вашей площадки можно через API-запрос Get source list) | | subid | Произвольный идентификатор, который вы можете использовать для дополнительной категоризации и отслеживания трафика. | | marketplace | Название маркетплейса: «Ozon», «Wildberries», «Avito», «Aliexpress» | | category\_id | id категории товара в виде числа (чтобы узнать соответствие числового кода названию категории товара, используйте запрос Get product categories list) | | favorite | Избранное (добавить в «Избранное» товар или удалить его оттуда можно только через личный кабинет) | | payment\_type | Модель оплаты: | | | cpa — оплата за заказ | | | cpc — оплата за клик с учетом продаж (СРС с учетом продаж) | | | cpmc — оплата за переход по ссылке с витрины на товар (СРС с витриной) | | | hcpa — оплата за продажи и фиксированная комиссия при достижении порога по кликам (Гибридная CPA) | | page | Номер страницы | | limit | Число записей на странице (по умолчанию выбрано число 50; допустимое значение от 1 до 1000) | :::cut{title="Пример использования (разверните)"} Пример запроса с использованием утилиты curl ```plain -H "Host: api.takprodam.ru" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.takprodam.ru/v2/publisher/product/?sou... \ --compressed ``` Пример ответа API-сервера в формате JSON ```plain { "total_count": 1000, "page": 1, "limit": 50, "items": [ { "id": "string", "product_id": 0, "title": "string", "image_url": "string", "price": 0.1, "commission": 0.1, "product_category": "string", "marketplace_title": "string", "store_title": "string", "external_link": "string", "favorite": true, "payment_type": "cpa", "tracking_link": "string", "legal_text": "string" } ] } ``` ::: ### Описание полей ответа API-сервера на Get products list with links | Поле | Описание | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------- | | id | Уникальный идентификатор товара | | product\_id | Уникальный идентификатор товара на маркетплейсе | | product\_sku | Уникальный идентификатор товара – SKU (артикул производителя) | | title | Название товара | | image\_url | Ссылка на изображение | | price | Цена товара | | commission | Комиссия за продвижение | | product\_category | Категория товара (чтобы узнать соответствие названий категорий их числовым кодам, используйте запрос Get product categories list) | | marketplace\_title | Название маркетплейса | | store\_title | Название магазина | | external\_link | Прямая ссылка на товар на маркетплейсе | | favorite | Избранное | | payment\_type | Модель оплаты | | tracking\_link | Партнерская ссылка на товар | | legal\_text | Маркировка рекламы | ## Get product categories list Возвращает информацию о категориях товаров для продвижения. URL запроса — https://api.takprodam.ru/v2/publisher/product-category/ :::caution Категории товаров обозначаются в виде чисел или названий. Метод Get product categories list позволяет соотнести числовой код категории с ее названием. ::: ### Список параметров для запроса: | Название | Допустимое значение | | ---------------- | ------------------- | | product-category | Категория товара | :::cut{title="Пример использования (разверните)"} Пример запроса с использованием утилиты curl ```plain -H "Host: api.takprodam.ru" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.takprodam.ru/v2/publisher/product-cate... \ --compressed ``` Пример ответа API-сервера в формате JSON ```markdown { "items": [ { "id": 0, "title": "string" } ] } ``` ::: ### Описание полей ответа API-сервера на Get product categories list | Поле | Описание | | ----- | ---------------------------------- | | id | Уникальный идентификатор категории | | title | Название категории товара | ## Get promotions list Возвращает информацию о действующих акциях и промокодах. URL запроса — https://api.takprodam.ru/v2/publisher/promotion/ ### Список параметров для запроса: | Название | Допустимое значение | | --------------- | ----------------------------------------------------------------------------------------------- | | source\_id | id площадки (узнать id вашей площадки можно через API-запрос Get source list) | | promotion\_id | id акции/промокода | | marketplace | Название маркетплейса: «Ozon», «Wildberries», «Avito», «Aliexpress» | | promotion\_type | Тип акции/промокода: | | | global\_sale — глобальные акции и распродажи маркетплейсов | | | sale — акции от продавцов | | | coupon — промокоды от продавцов | | favorite | Избранное (добавить в избранное товар или удалить его оттуда можно только через личный кабинет) | | page | Номер страницы | | limit | Число записей на странице (по умолчанию выбрано число 50; допустимое значение от 1 до 1000) | :::cut{title="Пример использования (разверните)"} Пример запроса с использованием утилиты curl ```txt -H "Host: api.takprodam.ru" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.takprodam.ru/v2/publisher/promotion/?s... \ --compressed ``` Пример ответа API-сервера в формате JSON ```txt { "total_count": 1000, "page": 1, "limit": 50, "items": [ { "id": 0, "title": "string", "promotion_type": "global_sale", "marketplace_title": "string", "store_title": "string", "discount_type": "fixed", "discount_value": 0, "start_date": "2019-08-24T14:15:22Z", "end_date": "2019-08-24T14:15:22Z", "coupon": "string", "landing_link": "string", "legal_text": "string" } ] } ``` #### Описание полей ответа API-сервера на Get promotions list | Поле | Описание | | | ------------------ | ---------------------------------------------------- | - | | id | Уникальный идентификатор акции/промокода | | | title | Название акции/промокода | | | promotion\_type | Тип акции/промокода | | | marketplace\_title | Название маркетплейса | | | store\_title | Название магазина | | | discount\_type | Тип скидки (в рублях или процентах) | | | discount\_value | Размер скидки | | | start\_date | Дата начала акции | | | end\_date | Дата окончания акции | | | coupon | Текст промокода | | | landing\_link | Ссылка на витрину товаров, которые участвуют в акции | | | legal\_text | Маркировка рекламы | | ::: ## Get promotion products Возвращает информацию о товарах, участвующих в акциях. URL запроса — https://api.takprodam.ru/v2/publisher/promotion/product/ ### Список параметров для запроса: | Название | Допустимое значение | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | source\_id | id площадки (узнать id вашей площадки можно через API-запрос Get source list) | | subid | Произвольный идентификатор, который вы можете использовать для дополнительной категоризации и отслеживания трафика. | | marketplace | Название маркетплейса: «Ozon», «Wildberries», «Avito», «Aliexpress» | | category\_id | id категории товара (чтобы узнать соответствие числового кода названию категории товара, используйте запрос Get product categories list) | | favorite | Избранное (добавить в избранное товар или удалить его оттуда можно только через личный кабинет) | | promotion\_id | id акции/промокода (можно узнать через запрос Get promotion list) | | page | Номер страницы | | limit | Число записей на странице (по умолчанию выбрано число 50; допустимое значение от 1 до 1000) | :::cut{title="Пример использования (разверните)"} Пример запроса с использованием утилиты curl ```txt -H "Host: api.takprodam.ru" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.takprodam.ru/v2/publisher/promotion/pr... \ --compressed ``` Пример ответа API-сервера в формате JSON ```txt { "total_count": 1000, "page": 1, "limit": 50, "items": [ { "id": "string", "product_id": 0, "title": "string", "image_url": "string", "price": 0.1, "price_discount": 0.1, "discount_percent": 0.1, "commission": 0.1, "product_category": "string", "marketplace_title": "string", "store_title": "string", "promotion_id": 0, "favorite": true, "tracking_link": "string", "legal_text": "string" } ] } ``` #### Описание полей ответа API-сервера на Get promotion products | Поле | Описание | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------- | | id | Уникальный идентификатор товара | | product\_id | Уникальный идентификатор товара на маркетплейсе | | product\_sku | Уникальный идентификатор товара – SKU (артикул производителя) | | title | Название товара | | image\_url | Ссылка на изображение | | price | Цена товара | | price\_discount | Цена товара со скидкой | | discount\_percent | Процент скидки | | commission | Комиссия за продажу | | product\_category | Категория товара (чтобы узнать соответствие названий категорий их числовым кодам, используйте запрос Get product categories list) | | marketplace\_title | Название маркетплейса | | store\_title | Название магазина | | promotion\_id | Уникальный идентификатор акции/промокода | | favorite | Избранное | | tracking\_link | Партнерская ссылка | | legal\_text | Маркировка рекламы | ::: ## Get source list Возвращает информацию о статусах площадки. URL запроса — https://api.takprodam.ru/v2/publisher/source/ :::tip Идентификатор площадки, полученный в ответе, используется в следующих API-запросах: Get products list with links, Get promotions list, Get promotion products. ::: ### Список параметров для запроса: | Название | Допустимое значение | | -------- | -------------------------- | | status | Статус площадки: | | | verification — на проверке | | | approved — подтверждена | | | declined — отклонена | :::cut{title="Пример использования (разверните)"} Пример запроса с использованием утилиты curl ```txt -H "Host: api.takprodam.ru" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.takprodam.ru/v2/publisher/source/?stat... \ --compressed ``` #### Пример ответа API-сервера в формате JSON ``` { "items": [ { "id": 0, "title": "string", "status": "verification", "source_type": { "id": 0, "type": "social_network", "title": "string", "slug": "string" }, "source_url": "string", "created_at": "2019-08-24T14:15:22Z" } ] } ``` ::: ### Описание полей ответа API-сервера на Get source list | Поле | Описание | | ------------ | --------------------------------- | | id | Уникальный идентификатор площадки | | title | Название площадки | | status | Статус площадки | | source\_type | Тип площадки | | source\_url | Ссылка на площадку | | created\_at | Дата создания площадки |