Возможности API вебмастеров

API	Описание
Постбэк (Webhook)	Получите информацию о заказах, товарах, а также изменении статуса партнерской программы.
XML с заказами	Получите XML-список заказов.
Статистика по офферам	Получите статистику по офферам в формате JSON или XML.
Условия офферов	Получите список офферов в формате JSON или XML.
Лендинги	Получите список лендингов в формате JSON или XML.
Акции	Получите список акций в формате JSON или XML.
Промокоды	Получите список купонов в формате JSON или XML.
Баннеры	Получите список баннеров в формате JSON или XML.
Категории	Получите список категорий в формате JSON или XML.
Типы трафика	Получите список типов трафика в формате JSON или XML.
Подготовленные фиды	Получите список товарных фидов в формате JSON или XML.
Сохраненные фиды	Получите список общих товарных фидов в форматах XML, GSF и CSV.
Статистика использования купонов	Получите статистику использования купонов в формате JSON или XML.
Cakelink	Перенаправьте пользователей на сайт партнёрской программы напрямую, без использования редиректора.
Бестселлеры	Получите список бестселлеров в формате JSON или XML.

Постбэк (Webhook)

Постбэк — это метод, используемый для быстрой передачи актуальной информации о заказах к вам в систему.

В настройках постбэков вы указываете URL вашего сервера и названия параметров, в которых хотели бы получать информацию, и, при возникновении события, по указанному URL совершается вызов с набором параметров и актуальных значений.

XML с заказами

Для получения XML-списка заказов, необходимо отправить GET-запрос на адрес:

https://api.advcake.ru/export/webmaster/{API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. days // отобразить заказы за заданное количество дней (не более 7), начиная от текущей даты (если не указано, то 1);

2. date_from и date_to // отобразить заказы в промежутке указанных дат (включительно). Формат дат: YYYY-MM-DD;

3. update_from и update_to // отобразить заказы, обновленные в промежутке указанных дат (включительно), формат дат: YYYY-MM-DD;

4. ids // отобразить список заказов, id которых перечисляются через запятую (1 и более элементов);

5. basket=1 // режим отображения заказов с корзиной (Будут отображены все заказы, если у них есть корзина – отобразится и она. Доступно только в Ecommerce-офферах);

6. paid // отобразить заказы, оплата по которым была произведена (yes) или не была произведена (no);

7. payment_status // отобразить заказы с указанным статусом выплаты вознаграждения:

   • open // открытая комиссия;

   • on_hold // на холде;

   • balance // согласованная комиссия;

   • processing // ожидает оплаты;

   • withdrawal // комиссия выведена;

   • not_apply // не подлежит выплате.

По умолчанию, если параметры не указаны, результатом станет вывод списка заказов за текущую дату.

Примеры:

1. Получить список заказов за последние 7 дней:

https://api.advcake.ru/export/webmaster/{API-key}?days=7

2. Получить список заказов по выбранному офферу:

https://api.advcake.ru/export/webmaster/{API-key}?offer=demo

3. Получить список заказов по выбранному ID оффера:

https://api.advcake.ru/export/webmaster/{API-key}?offer_id=240

4. Получить информацию по заказам с ID 123, 456 и 789:

https://api.advcake.ru/export/webmaster/{API-key}?ids=123,456,789

5. Получить список заказов с корзиной за текущую дату:

https://api.advcake.ru/export/webmaster/{API-key}?basket=1

6. Получить список заказов с 14 по 21 февраля 2023 года включительно:

https://api.advcake.ru/export/webmaster/{API-key}?date_from=2022-11-03&date_to=2022-11-10

7. Получить список заказов, обновленных с 14 по 21 февраля 2023 года включительно:

https://api.advcake.ru/export/webmaster/{API-key}?update_from=2022-11-03&update_to=2022-11-10

8. Получить список готовых к оплате заказов за последние 7 дней:

https://api.advcake.ru/export/webmaster/{API-key}?days=7&payment_status=balance

9. Получить список заказов за последние 7 дней, оплата по которым не была произведена:

https://api.advcake.ru/export/webmaster/{API-key}?days=7&paid=no

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

Нажмите, чтобы посмотреть пример ответа

<?xml version="1.0" encoding="UTF-8"?>
<items>
    <item>
        <offer>demo</offer> <!-- Оффер -->
        <offer_id>6</offer_id> <!-- ID оффера внутри системы -->
        <order_id>820217</order_id> <!-- Id заказа -->
        <click_id>f7230324edc38a5a2e9690656941b19d</click_id> <!-- уникальный ID клика -->
        <clicked_at>2018-03-16 12:36:23</clicked_at> <!-- Время клика -->
        <date>2018-03-16 15:57:04</date> <!-- Дата создания -->
        <dateChange>2018-03-16 15:57:05</dateChange> <!-- Дата последнего изменения -->
        <price>700</price> <!-- Стоимость товара (для CPS) -->
        <commission>42</commission> <!-- Выплата -->
        <status>1</status> <!-- Статус (1 - новый, 2 - подтвержден, 3 - отменён) -->
        <ip>198.51.100.100</ip> <!-- IP, с которого был совершен заказ -->
        <reason>test order</reason> <!-- Причина отмены заказа -->
        <paid>yes</paid> <!-- Информация о статусе оплаты заказа -->
        <invoice_id>12345</invoice_id> <!-- Информация об ID счета вебмастера, включающего заказ (только для юридических лиц) -->
        <payment_id>34567</payment_id> <!-- Информация об ID оплаты заказа (для всех, кроме юридических лиц) -->
        <payment_status>open</payment_status> <!-- Статус выплаты заказа (on_hold - На холде, open - Открытая комиссия, processing - Ожидает оплаты, balance - Согласованная комиссия, withdrawal - Комиссия выведена, not_apply - Не подлежит выплате) -->
        <bid>24,15 %</bid> <!-- Итоговая ставка для заказа -->
        <category>clothes</category> <!-- Категория заказа (на некоторых офферах) -->
        <customer>old</customer> <!-- Новый или ребилл (на некоторых офферах) -->
        <course>Без курса</course> <!-- Наименование курса (на некоторых офферах) -->
        <link_hash>6a6a1b5936d49cf5</link_hash> <!-- Уникальный хэш короткой ссылки, если есть -->
        <landing_id>1841</landing_id> <!-- Уникальный id лендинга, если есть -->
        <keyword>Купить одежду</keyword> <!-- Ключевое слово, которое можно передать через генератор ссылок -->
        <sub1>banner1</sub1> <!-- Дополнительные параметры заказа, которые можно указывать через генератор ссылок -->
    </item>
</items>

Пример ответа с корзиной:

Нажмите, чтобы посмотреть пример ответа

<?xml version="1.0" encoding="UTF-8"?>
    <items>
        <item>
            <offer>demo</offer> <!-- Оффер -->
            <offer_id>6</offer_id> <!-- ID оффера внутри системы -->
            <order_id>820217</order_id> <!-- Id заказа -->
            <click_id>f7230324edc38a5a2e9690656941b19d</click_id> <!-- уникальный ID клика -->
            <clicked_at>2018-03-16 12:36:23</clicked_at> <!-- Время клика -->
            <date>2018-03-16 15:57:04</date> <!-- Дата создания -->
            <dateChange>2018-03-16 15:57:05</dateChange> <!-- Дата последнего изменения -->
            <price>700</price> <!-- Стоимость товара (для CPS) -->
            <commission>42</commission> <!-- Выплата -->
            <status>1</status> <!-- Статус (1 - новый, 2 - подтвержден, 3 - отменён) -->
            <ip>198.51.100.100</ip> <!-- IP, с которого был совершен заказ -->
            <reason>test order</reason> <!-- Причина отмены заказа -->
            <paid>yes</paid> <!-- Информация о статусе оплаты заказа -->
            <invoice_id>12345</invoice_id> <!-- Информация об ID счета вебмастера, включающего заказ (только для юридических лиц) -->
            <payment_id>34567</payment_id> <!-- Информация об ID оплаты заказа (для всех, кроме юридических лиц) -->
            <payment_status>open</payment_status> <!-- Статус выплаты заказа (on_hold - На холде, open - Открытая комиссия, processing - Ожидает оплаты, balance - Согласованная комиссия, withdrawal - Комиссия выведена, not_apply - Не подлежит выплате) -->
            <bid>24,15 %</bid> <!-- Итоговая ставка для заказа -->
            <category>clothes</category> <!-- Категория заказа (на некоторых офферах) -->
            <customer>old</customer> <!-- Новый или ребилл (на некоторых офферах) -->
            <course>Без курса</course> <!-- Наименование курса (на некоторых офферах) -->
            <basket> <!-- Корзина -->
                <item> <!-- Элемент корзины -->
                    <pid>71210387</pid> <!-- ID товара -->
                    <pn>Название товара</pn> <!-- Название товара в корзине -->
                    <up>700</up> <!-- стоимость за единицу -->
                    <pc>Категория</pc> <!-- Название категории -->
                    <qty>1</qty> <!-- Количество -->
                    <wc>42</wc> <!-- Выплата за товар, если рассчитывается по корзине -->
                </item>
            </basket>
            <link_hash>6a6a1b5936d49cf5</link_hash> <!-- Уникальный хэш короткой ссылки, если есть -->
            <landing_id>1841</landing_id> <!-- Уникальный id лендинга, если есть -->
            <keyword>Купить одежду</keyword> <!-- Ключевое слово, которое можно передать через генератор ссылок -->
            <sub1>banner1</sub1> <!-- Дополнительные параметры заказа, которые можно указывать через генератор ссылок -->
        </item>
    </items>

Статистика по офферам

Для получения статистики по офферам в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/stat?pass={API-key}

Дополнительно могут быть указаны следующие GET-параметры:

1. days // отобразить статистику для офферов по заказам, созданным за заданное количество дней, начиная от текущей даты (если не указано, то 30);

2. date_from и date_to // отобразить статистику для офферов по заказам, созданным в промежутке указанных дат (включительно), формат дат: YYYY-MM-DD

3. update_from и update_to // отобразить статистику для офферов по заказам, обновленным в промежутке указанных дат (включительно), формат дат: YYYY-MM-DD

4. goal=1 // режим отображения статистики для финансовых офферов с дополнительной подробной статистикой по продуктам;

5. offer_id // отобразить статистику для оффера с указанным ID;

6. offer_alias // отобразить статистику для оффера с указанным алиасом;

7. offset // отобразить статистику для офферов, начиная с указанного порядкового номера;

8. limit // задать лимит выводимых офферов со статистикой;

9. type // выбрать формат ответа Json или XML. По умолчанию Json;

По умолчанию, если параметры не указаны, результатом станет вывод списка статистики по всем доступным офферам по заказам, созданным за 30 дней, в формате Json.

Примеры:

1. Получить статистику для офферов по заказам, созданным за последние 30 дней:

https://api.advcake.com/stat?pass={API-key}&days=30

2. Получить статистику для офферов по заказам, созданным с 2024-05-21 по 2024-06-20 года включительно:

https://api.advcake.ru/stat?pass={API-key}&date_from=2024-05-21&date_to=2024-06-20

3. Получить статистику для офферов по заказам, обновленным с 2024-05-21 по 2024-06-20 года включительно:

https://api.advcake.ru/stat?pass={API-key}&update_from=2024-05-21&update_to=2024-06-20

4. Получить статистику для оффера c ID = 240:

https://api.advcake.com/stat?pass={API-key}&offer_id=240

5. Получить статистику для оффера c алиасом = demo:

https://api.advcake.com/stat?pass={API-key}&offer_alias=demo

6. Получить статистику для офферов, начиная с 5-го в списке:

https://api.advcake.com/stat?pass={API-key}&offset=5

7. Установить лимит на количество полученных офферов, равный 10

https://api.advcake.com/stat?pass={API-key}&limit=10

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2024-06-11 10:34:18",
    "total": 1,
    "data": [
        {
            "offer": "Demo",
            "offer_id": 240,
            "offer_alias": "demo",
            "visits": 1234,
            "orders_total": 123,
            "orders_approved": 12,
            "orders_pending": 23,
            "orders_rejected": 34,
            "comission_total": 12345,
            "comission_approved": 1234,
            "comission_pending": 2345,
            "comission_rejected": 234,
            "average_bid": 0.0123,
            "cr": 0.0997,
            "ar": 0.0976,
            "epl": 102.8333,
            "goal": []
        }
    ]
}

Пример ответа c подробной статистикой по продуктам:

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2024-06-11 10:34:18",
    "total": 1,
    "data": [
        {
            "offer": "Demo",
            "offer_id": 240,
            "offer_alias": "demo",
            "visits": 1234,
            "orders_total": 123,
            "orders_approved": 12,
            "orders_pending": 23,
            "orders_rejected": 34,
            "comission_total": 12345,
            "comission_approved": 1234,
            "comission_pending": 2345,
            "comission_rejected": 234,
            "average_bid": 0.0123,
            "cr": 0.0997,
            "ar": 0.0976,
            "epl": 102.8333,
            "goal": [
                {
                    "goal_name": "PKO",
                    "visits": 1234,
                    "orders_total": 123,
                    "orders_approved": 12,
                    "orders_pending": 23,
                    "orders_rejected": 34,
                    "comission_total": 12345,
                    "comission_approved": 1234,
                    "comission_pending": 2345,
                    "comission_rejected": 234,
                    "average_bid": 0.0123,
                    "cr": 0.0997,
                    "ar": 0.0976,
                    "epl": 102.8333
                }
            ]
        }
    ]
}

Описание получаемых параметров:

1. total // число офферов, подходящих под запрос;

2. offer // название оффера;

3. offer_id // id оффера;

4. offer_alias // алиас оффера;

5. visits // количество визитов за указанный период;

6. orders_total // количество всех заказов за указанный период;

7. orders_approved //к оличество подтвержденных заказов за указанный период;

8. orders_pending // количество заказов в ожидании за указанный период;

9. orders_rejected // количество отмененных заказов за указанный период;

10. comission_total // комиссия всех заказов за указанный период;

11. comission_approved // комиссия подтвержденных заказов за указанный период;

12. comission_pending // комиссия заказов в ожидании за указанный период;

13. comission_rejected // комиссия отмененных заказов за указанный период;

14. average_bid // средняя ставка по заказам за указанный период;

15. cr // отношение количества заказов к визитам;

16. ar // процент одобрения заказов;

17. epl // средняя комиссия одобренных лидов;

18. goal // подробная статистика по продуктам, доступна только в финансовых офферах.

Условия офферов

Для получения списка офферов в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/offers?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. website // отобразить офферы имеющие указанный сайт;

2. source_type // отобразить офферы c указанным типом трафика;

3. last_update_after // получить список офферов обновленных после указанной даты;

4. limit // задать лимит выводимых офферов;

5. offset // отобразить офферы начиная с указанного порядкового номера;

6. type // выбрать формат ответа Json или XML. По умолчанию Json;

7. with_bids=1 // добавить ставки программы в вывод;

8. with_landings=0 // не выводить данные лендингов программы.

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру офферов.

Примеры:

1. Получить список офферов с вебсайтом google.com:

https://api.advcake.com/offers?pass={API-key}&website=google.com

2. Получить список офферов с типом трафика cashback:

https://api.advcake.com/offers?pass={API-key}&source_type=cashback

3. Получить список офферов обновленных после 2020-10-01:

https://api.advcake.com/offers?pass={API-key}&last_update_after=2020-10-01

4. Установить лимит на количество полученных офферов равный 10:

https://api.advcake.com/offers?pass={API-key}&limit=10

5. Получить офферы начиная с 5-го в списке:

https://api.advcake.com/offers?pass={API-key}&offset=5

6. Получить список офферов с актуальными ставками:

https://api.advcake.com/offers?pass={API-key}&with_bids=1

7. Получить список офферов без лендингов:

https://api.advcake.com/offers?pass={API-key}&with_landings=0

8. Также, можно указать ID оффера, который необходимо получить: например, получить офферы с ID = 2:

https://api.advcake.com/offers/2?pass={API-key}

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "dt": "2020-01-01 11:11:11",
    "total": 74,
    "data": [{
            "id": 1,
            "alias": "tutu",
            "name": "tutu.ru",
            "description": "Партнерская программа tutu.ru Туту.ру — российский сервис путешествий №1. Больше 20 млн посетителей сайта Tutu.ru в месяц. Топ-30 мировых travel-сайтов. Конверсионные лендинги: Продажа ж/д билетов: tutu.ru/poezda , tutu.ru/poezda/mini , tutu.travel (английская версия), Продажа авиабилетов: avia.tutu.ru Продажа билетов на автобусы: bus.tutu.ru, https://by.tutu.travel/bus (версия для Белоруссии) Инструменты :",
            "country": "RU",
            "currency": "RUB",
            "website_url": "https://www.tutu.travel",
            "thumbnail": "https://static.advcake.com/upload/offers/offer_logo_1543589151576.png",
            "category": "travel",
            "type": "CPA",
            "action_type": "lead",
            "cookie_lifetime": 30,
            "hold": 30,
            "available": true,
            "active": true,
            "geos": [{
                "name": "RU"
            }],
            "traffic_types": [{
                "id": 11,
                "name": "Таргет. в соц.сетях",
                "alias": "target",
                "available": true
            }],
            "bids": [ //при &with_bids=1
                {
                    "id": 3346,
                    "value": 2.91,
                    "max_commission": 30000,
                    "type": "percent",
                    "text": "Ставка 2.912% + 499.98 рублей (не более 30 000 ₽) с 2020-08-23 на отдельные категории: Автобус",
                    "condition": {
                        "start_date": "2020-08-23",
                        "category": [
                            "Автобус"
                        ]
                    }
                }
            ],
            "landings": [{
                "id": 10,
                "name": "Основной сайт",
                "promotional": "false",
                "available_deep_link": true,
                "link": "http://tutu.ru/?dagent=advcake&utm_source=advcake&utm_medium=cpa&utm_campaign={partner}&utm_content={webmaster}&advcake_params={click_id}"
            }],
            "export": "https://api.advcake.ru/export/webmaster/{api_key}?offer=tutu"
        ]},
    }
}

Описание получаемых параметров:

1. total // число партнерских программ, подходящих под запрос;

2. id // id партнерской программы в системе;

3. alias // строковый id партнерской программы в системе;

4. name // название партнерской программы;

5. description // краткое описание партнерской программы;

6. country // страна партнерской программы;

7. currency // валюта партнерской программы;

8. website_url // сайт партнерской программы;

9. thumbnail // логотип;

10. category // категория (Список возможных);

11. type // тип (CPA/CPO/CPC);

12. action_type // тип действия (lead/ecommerce);

13. cookie_lifetime // срок жизни куки;

14. hold // срок холда;

15. available // доступна(да/нет);

16. active // активна(да/нет);

17. geos // ГЕО для работы с партнерской программой;

18. traffic_types // разрешенные и запрещенные типы трафика;

19. landings // список лендингов партнерской программы;

20. bids // ставки;

    • id // id ставки в системе;

    • value // значение ставки;

    • max_commission // максимальная возможная комиссия вебмастера за заказ;

    • type // тип ставки(процент/фикс в рублях);

    • text // текстовое описание ставки;

    • condition // условия;

      • goal // название продукта (для фин.офферов);

      • traffic_type // для указанного типа трафика;

      • excluded_traffic_type //исключая тип трафика;

      • start_date // дата начала ставки;

      • end_date // дата окончания ставки;

      • category // для указанных категорий;

      • coupon // с купоном(Да/Нет);

      • min_price // минимально необходимая сумма заказа;

      • min_item_price // минимально необходимая сумма элемента корзины;

      • customer_type // тип клиента(Новый/Старый);

      • adv_sub // ключевое слово;

      • adv_sub2 // ключевое слово 2.

21. export // XML выгрузка со статистикой

Лендинги

Для получения списка лендингов в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/landings?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отобразить лендинги для оффера с указанным ID;

2. offer_alias // отобразить лендинги для оффера с указанным алиасом;

3. offset // отобразить лендинги начиная с указанного порядкового номера;

4. limit // задать лимит выводимых лендингов;

5. type // выбрать формат ответа JSON или XML (по умолчанию JSON);

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру лендингов.

Примеры:

1. Поиск лендингов для оффера c ID = 240:

https://api.advcake.com/landings?pass={API-key}&offer_id=240

2. Поиск лендингов для оффера c алиасом = clarins

https://api.advcake.com/landings?pass={API-key}&offer_alias=clarins

3. Установить лимит на количество полученных лендингов равный 10:

https://api.advcake.com/landings?pass={API-key}&limit=10

4. Получить лендинги начиная с 5-го в списке:

https://api.advcake.com/landings?pass={API-key}&offset=5

5. Также, можно указать ID лендинга, который необходимо получить: например, получить лендинг с ID = 1037:

https://api.advcake.com/landings?pass={API-key}&offset=5

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-10-13 14:47:49",
    "total": 1,
    "data": [
        {
            "id": 2186,
            "name": "Электронный полис ОСАГО (июнь2020)",
            "offer_id": 240,
            "offer_alias": "clarins"
            "kktu": "x.x.x",
            "type": "desktop",
            "allow_deep": true,
            "url": "https://shop.vsk.ru/osago/calculation/?_ref=sdfsdf=advcake&utm_medium=cpa&utm_campaign=vsk_osago_2020&utm_term={partner}_{webmaster}_{click_id}",
            "active": true,
            "private": false
        }
    ]
}

Описание получаемых параметров:

1. total // число лендингов, подходящих под запрос;

2. id // id лендинга в системе;

3. name // название лендинга;

4. offer_id // оффер ID лендинга;

5. offer_alias // алиас оффера лендинга;

6. type // тип лендинга (mobile/desktop);

7. kktu // код ККТУ, определяется только на стороне рекламодателя, должен содержать три числа от 1-999 с разделителем точка между ними (например, 1.1.1 или 999.999.999). Необходим для регистрации креатива в ОРД;

8. allow_deep // поддерживается ли DeepLink;

9. url // url лендинга;

10. active // активен ли лендинг;

11. private // эксклюзивность лендинга.

Акции

Для получения списка акций в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/promotions?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отобразить акции для оффера с указанным ID;

2. offset // отобразить акции начиная с указанного порядкового номера;

3. limit // задать лимит выводимых акции;

4. type // выбрать формат ответа JSON или XML (по умолчанию JSON).

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру акций.

Примеры:

1. Поиск акций для оффера c ID = 240:

https://api.advcake.com/promotions?pass={API-key}&offer_id=240

2. Установить лимит на количество полученных акций равный 10:

https://api.advcake.com/promotions?pass={}&limit=10

3. Получить акции начиная с 5-го в списке:

https://api.advcake.com/promotions?pass={}&offset=5

4. Также, можно указать ID акции, которую необходимо получить: например, получить акции с ID = 1900:

https://api.advcake.com/promotions/1900?pass={API-key}

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-10-15 15:30:11",
    "total": 1,
    "data": [
        {
            "id": 14,
            "title": "Все ужины бесплатно!",
            "description": "Закажи любое меню сегодня и все ужины в нём будут стоить 0₽",
            "offer_id": 11,
            "offer_name": "example.com",
            "date_start": "2020-00-00", // сегодня –7 дней
            "date_end": "2020-00-00", // сегодня +7 дней
            "active": true,
            "private": false,
            "goal": null,
            "promocodes": [
                {
                    "id": "pc2345",
                    "name": "Промокод",
                    "short_name": "Скидка 60% на заказ",
                    "description": "Описание промокода",
                    "discount": 60,
                    "discount_type": "percent",
                    "active": true,
                    "private": false,
                    "forced_attribution": false,
                    "referral_link": "https://go.redav.online/example?erid=example&m=6"
                }
            ],
            "landings": [
                {
                    "id": 2193,
                    "name": "Все ужины бесплатно!",
                    "promotional": "true",
                    "link": "https://go.redav.online/example?erid=example&m=33"
                }
            ],
            "banners": [
                {
                    "id": 11691,
                    "name": "300 x 250",
                    "banner_image_url": "https://example.com/example.png",
                    "size_width": 300,
                    "size_height": 250,
                    "mime_type": "image/png",
                    "active": true,
                    "private": false
                }
            ]
            "status": "active",
            "min_price": null,
            "present_title": "",
            "present_url": "",
            "present_image": "",
            "categories_selection": "all",
            "categories_list": null,
            "categories_names": null,
            "categories": null,
            "type": "discount",
            "short_name": "Скидка 60% на заказ",
            "discount": 60,
            "discount_type": "percent"
        }
    ]
}

Описание получаемых параметров:

1. total // число акций, подходящих под запрос;

2. id // id акции в системе;

3. title // заголовок акции;

4. description // краткое описание акции;

5. offer_id // оффер ID акции;

6. date_start // дата начала акции;

7. date_end // дата окончания акции;

8. active // активна ли акция;

9. private // эксклюзивность акции;

10. goal // данные о привязанных к акции финансовых продуктах;

11. promocodes // список купонов связанных с акцией;

12. landings // список лендингов связанных с акцией;

13. banners // список баннеров связанных с акцией;

14. status // статус акции;

15. min_price // минимальная сумма заказа по акции;

16. present_title // название подарка по акции;

17. present_url // url подарка по акции;

18. present_image // url изображения подарка по акции;

19. categories_selection // выборка категорий из товарного фида для купона [all/only/except];

20. categories_list // ???;

21. categories_names // ???;

22. categories // категории товарного фида, относящиеся к выборке;

23. type // тип акции [discount/free_delivery/present/other];

24. short_name // краткое описание акции;

25. discount // скидка по акции;

26. discount_type // тип скидки [percent/rub].

Промокоды

Для получения списка купонов в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/promocodes?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отобразить купоны для оффера с указанным ID;

2. offset // отобразить купоны начиная с указанного порядкового номера;

3. limit // задать лимит выводимых купонов. Не более 300 записей;

4. type // выбрать формат ответа JSON или XML (по умолчанию JSON).

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру купонов.

Примеры:

1. Поиск купонов для оффера c ID = 240:

https://api.advcake.com/promocodes?pass={API-key}&offer_id=240

2. Установить лимит на количество полученных купонов равный 10:

https://api.advcake.com/promocodes?pass={API-key}&limit=10

3. Получить купоны начиная с 5-го в списке:

https://api.advcake.com/promocodes?pass={API-key}offset=5

4. Также, можно указать ID купона, который необходимо получить: например, получить купон с ID = 480:

https://api.advcake.com/promocodes/480?pass={API-key}

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

Нажмите, чтобы посмотреть пример ответа

{
    "success":true,
    "date":"2024-11-02 17:17:35", // текущая дата и время
    "total":1,
    "data": [
        {
            "id":"pc1234",
            "name":"Промокод",
            "short_name":"Краткое описание",
            "offer_id":135,
            "offer_name":"example.com",
            "offer_url":"https://example.com",
            "description":"Описание промокода",
            "min_price":null,
            "discount":10,
            "discount_type":"percent",
            "date_start":"2024-10-26", // сегодня –7 дней
            "date_end":"2024-11-09", // сегодня +7 дней
            "active":true,
            "forced_attribution":false,
            "referral_link":"https://go.redav.online/example?erid=example&m=34",
            "private":false,
            "present_title":null,
            "present_url":null,
            "present_image":null,
            "type":"discount",
            "promotion":{
                "id":"pr2345",
                "title":"Название акции",
                "description":"Описание акции"
            },
            "landing":{
                "id":"ln3456",
                "name":"Название лендинга",
                "promotional":"false",
                "available_deep_link":true,
                "originalLink":"https://example.com",
                "link":"https://go.redav.online/example?erid=example&m=34"
            },
            "banners":[
                {
                    "id":"bn4567",
                    "name":"Название баннера",
                    "type":"Акционный",
                    "size_width":728,
                    "size_height":90,
                    "banner_image_url":"https://example.com/example.png",
                    "mime_type":"image/png"
                }
            ],
            "categories_selection":"all",
            "categories":null,
            "status":"active",
            "used_24h":false,
            "used_7d":false,
            "last_use":"2024-11-01 18:32:27", // сегодня - 1 день
            "min_price_24h":null,
            "min_price_7d":null,
            "chance":"low"
        }
    ]
}

Описание получаемых параметров:

1. total // число купонов, подходящих под запрос;

2. id // id купона в системе;

3. name // название купона;

4. offer_id // оффер ID купона;

5. description // описание купона;

6. discount // скидка;

7. discount_type // тип скидки [percent/rub];

8. min_price // минимально необходимая сумма;

9. date_start // дата начала действия купона(может отсутствовать);

10. date_end// дата окончания действия купона(может отсутствовать);

11. active // активен ли купон;

12. private // эксклюзивность купона;

13. present_title // название подарка;

14. present_url // url подарка;

15. present_image // url изображения подарка;

16. type // тип купона [discount/free_delivery/present ];

17. used_24h // использовался ли за последние сутки (true/false);

18. used_7d // использовался ли за последнюю неделю (true/false);

19. last_use // дата последнего использования;

20. min_price_24h // минимальная сумма заказа при использовании купона за последние сутки;

21. min_price_7d // минимальная сумма заказа при использовании купона за последнюю неделю;

22. chance // вероятность работоспособности купона (very high/high/medium/below the average/low);

23. categories_selection // выборка категорий из товарного фида для купона [all/only/except];

24. categories // категории товарного фида, относящиеся к выборке.

Баннеры

Для получения списка баннеров в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/banners?pass={API-key}offer_id={}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Обязательно должен быть указан следующий GET-параметр:

offer_id //отобразить баннеры для оффера с указанным ID.

Дополнительно могут быть указаны следующие GET-параметры:

1. offset // отобразить баннеры начиная с указанного порядкового номера;

2. limit // задать лимит выводимых баннеров (по умолчанию 100);

3. type // выбрать формат ответа JSON или XML (по умолчанию JSON).

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру баннеров.

Примеры:

1. Установить лимит на количество полученных баннеров равный 10:

https://api.advcake.com/banners?pass={API-key}offer_id={}&limit=10

2. Получить баннеры начиная с 5-го в списке:

https://api.advcake.com/banners?pass={API-key}offer_id={}&offset=5

3. Также, можно указать ID баннера, который необходимо получить: например, получить баннер с ID = 636:

https://api.advcake.com/banners/636?pass={API-key}

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-10-12 13:56:33",
    "total": 1,
    "data": [
        {
            "id": 636,
            "name": "250x250",
            "offer_id": 1,
            "size_width": 250,
            "size_height": 250,
            "banner_image_url": "https://static.advcake.com/upload/banners/alias/e3d36ea9b24c53a.jpg",
            "mime_type": "image/jpeg",
            "active": true,
            "private": false
        }
    ]
}

Описание получаемых параметров:

1. total // число баннеров, подходящих под запрос;

2. id // id баннера в системе;

3. name // название баннера;

4. offer_id / /оффер ID баннера;

5. size_width // ширина баннера;

6. size_height // высота баннера;

7. banner_image_url // url баннера;

8. mime_type // тип баннера;

9. date_start // дата начала действия баннера(может отсутствовать);

10. date_end// дата окончания действия баннера(может отсутствовать);

11. active // активен ли баннер;

12. private // эксклюзивность баннера.

Категории

Для получения списка категорий в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/offer-categories?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отобразить категорий для оффера с указанным ID;

2. type // выбрать формат ответа JSON или XML (по умолчанию JSON).

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру категорий.

Примеры:

Поиск категорий для оффера c ID = 1:

https://api.advcake.com/offer-categories?pass={API-key}&offer_id=1

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-10-14 14:38:39",
    "total": 1,
    "data": [
        {
            "alias": "travel",
            "name": "Туризм",
            "total": 86
        }
    ]
}

Описание получаемых параметров:

1. total // число категорий, подходящих под запрос;

   • alias // алиас категории;

   • name // название категории;

   • total // количество офферов в категории.

Типы трафика

Для получения списка типов трафика в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/sources?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offset // отобразить типы трафика начиная с указанного порядкового номера;

2. limit // задать лимит выводимых типов трафика;

3. type // выбрать формат ответа JSON или XML (по умолчанию JSON).

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру типов трафика.

Примеры:

1. Установить лимит на количество полученных типов трафика равный 10:

https://api.advcake.com/sources?pass={API-key}&limit=10

2. Получить типы трафика начиная с 5-го в списке:

https://api.advcake.com/sources?pass={API-key}&offset=5

3. Также, можно указать ID типа трафика, который необходимо получить: например, получить тип трафика с ID = 4:

https://api.advcake.com/sources/4?pass={API-key}

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-10-15 13:45:31",
    "total": 1,
    "data": [
        {
            "id": 4,
            "alias": "push",
            "name": "Push"
        }
    ]
}

Описание получаемых параметров:

1. total// число типов трафика, подходящих под запрос;

2. id // id типа трафика в системе;

3. alias // алиас типа трафика;

4. name // название типа трафика.

Подготовленные фиды

Для получения списка общих товарных фидов в форматах XML, GSF и CSV по API необходимо отправить GET запрос на адрес:

https://api.advcake.com/common-feeds?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отобразить фиды для оффера с указанным ID;

2. offset // отобразить фиды начиная с указанного порядкового номера;

3. limit // задать лимит выводимых фидов.

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру фидов.

Примеры:

1. Поиск фидов для оффера c ID = 240:

https://api.advcake.com/common-feeds?pass={API-key}&offer_id=240

2. Установить лимит на количество полученных фидов равный 10

https://api.advcake.com/common-feeds?pass={API-key}&limit=10

3. Получить фиды начиная с 5-го в списке:

https://api.advcake.com/common-feeds?pass={API-key}&offset=5

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2022-02-18 12:11:14",
    "total": 3,
    "data": [
        {
        "feed_id": 56,
        "format": "yml",
        "offer": "otuf.com",
        "title": "Общий товарный фид",
        "url": "http://feeds.advcake.com/feed/download/c6e5edb04316a1c8fead4a1e5fe?webmaster=web1",
        "offer_id": 491,
        "products_count": 64,
        "last_download": "2022-01-31 10:33:02",
        "last_update": "2022-01-30 13:25:21"
        },
        {
        "feed_id": 15,
        "format": "csv",
        "offer": "otuf.com",
        "title": "Общий товарный фид",
        "url": "http://feeds.advcake.com/feed/download/df7ff14f1a84a3a44a77d3fe21a?webmaster=web1",
        "offer_id": 491,
        "products_count": 979,
        "last_download": "2022-01-30 13:17:34",
        "last_update": "2022-01-30 13:25:22"
        },
        {
        "feed_id": 45,
        "format": "gsf",
        "offer": "otuf.com",
        "title": "Общий товарный фид",
        "url": "http://feeds.advcake.com/feed/download/b4afdfdf12f9ae2fe39a15e2f59?webmaster=sweb1",
        "offer_id": 491,
        "products_count": 64,
        "last_update": "2022-01-30 13:25:21"
        }
    ]
}

Описание получаемых параметров:

1. feed_id // ID фида;

2. format // формат отдаваемых фидов;

3. offer // оффер фида;

4. title // название фида;

5. total // число фидов, подходящих под запрос;

6. url // url для скачивания фида;

7. offer_id // ID оффера фида;

8. products_count // кол-во продуктов в фиде;

9. last_download // время последнего скачивания;

10. last_update // время последнего обновления;

11. total // число фидов, подходящих под запрос, учитывая разные форматы.

Сохраненные фиды

Для получения списка товарных фидов по API в формате JSON или XML, необходимо сгенерировать нужный товарный фид в разделе «Инструменты» → «Товарные фиды», сохранить его и отправить GET-запрос на адрес:

https://api.advcake.com/feeds?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отобразить фиды для оффера с указанным ID;

2. offset // отобразить фиды начиная с указанного порядкового номера;

3. limit // задать лимит выводимых фидов;

4. type // выбрать формат ответа JSON или XML (по умолчанию JSON).

По умолчанию, если параметры не указаны, результатом станет вывод списка всех доступных вебмастеру/партнеру фидов.

Примеры:

1. Поиск фидов для оффера c ID = 240:

https://api.advcake.com/feeds?pass={API-key}&offer_id=240

2. Установить лимит на количество полученных фидов равный 10

https://api.advcake.com/feeds?pass={API-key}&limit=10

3. Получить фиды начиная с 5-го в списке:

https://api.advcake.com/feeds?pass={API-key}&offset=5

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-10-15 19:03:12",
    "total": 3,
    "data": [
        {
            "id": 1535,
            "title": "Фид для Яндекс.Маркета",
            "offer_id": 240,
            "url": "https://feeds.advcake.com/feed/download/f538d1256de111111",
            "products_count": 429,
            "last_download": "2020-06-03 18:56:28"
        },
        {
            "id": 1538,
            "title": "Фид для Google",
            "offer_id": 240,
            "url": "https://feeds.advcake.com/feed/download/92e1c1ca71ac222222",
            "products_count": 429,
            "last_download": "2020-04-09 13:19:29"
        },
        {
            "id": 1540,
            "title": "Фид для Facebook",
            "offer_id": 240,
            "url": "https://feeds.advcake.com/feed/download/4947b16ffe333333",
            "products_count": 429,
            "last_download": "2020-04-09 13:19:09"
        }
    ]
}

Описание получаемых параметров:

1. total // число фидов, подходящих под запрос;

2. id // id фида в системе;

3. title // название фида;

4. offer_id // оффер ID фида;

5. url // url для скачивания фида;

6. products_count // кол-во продуктов в фиде;

7. last_download // время последнего скачивания.

Статистика использования купонов

Для получения статистики использования купонов в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/promocodes/statistic?coupons=coupon2,coupon3&pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

В параметре coupons перечислите купоны через запятую.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отображение статистики по конкретному офферу;

2. type // выбрать формат ответа ответа JSON или XML (по умолчанию JSON).

Примеры:

1. Поиск статистики для оффера c ID = 240:

https://api.advcake.com/promocodes/statistic?coupons=coupon2,coupon3&pass={}&offer_id=240

2. Получить статистику по купонам «coupon1», «coupon2» и «coupon3»:

https://api.advcake.com/promocodes/statistic?coupons=coupon2,coupon3&pass={API-key}

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-11-02 16:09:26",
    "total": 2,
    "data": [
        {
            "coupon": "coupon2",
            "offer_id": 86,
            "last_use": "2020-11-08 18:50:07",
            "accessed": false,
            "usage_data": {
                "used_24h": false,
                "used_7d": true,
                "last_use": "2020-11-08 18:50:07",
                "min_price_24h": null,
                "min_price_7d": 23990,
                "chance": "high"
            }
        },
        {
            "coupon": "coupon3",
            "offer_id": 33,
            "last_use": "2020-11-04 17:08:02",
            "accessed": true,
            "usage_data": {
                "used_24h": false,
                "used_7d": true,
                "last_use": "2020-11-04 17:08:02",
                "min_price_24h": null,
                "min_price_7d": 144950,
                "chance": "below the average"
            },
            "coupon_data": {
                "id": "pc641",
                "name": "ЧАСЫ2500",
                "offer_id": 333,
                "description": "Скидка 2500 р. по промокоду",
                "min_price": null,
                "discount": 2500,
                "discount_type": "rub",
                "date_start": "2020-10-07",
                "date_end": "2021-01-04",
                "active": true,
                "private": false,
                "promotion": {
                    "id": "pr1895",
                    "title": "Скидка 2500 р. по промокоду",
                    "description": "Скидка 2500 р. по промокоду"
                },
                "landing": {
                    "id": "ln2671",
                    "name": "Скидка 2500 р.",
                    "promotional": "true",
                    "link": "https://go.acstat.com/c97e4333c"
                },
                "banners": []
            }
        }
    ]
}

Описание получаемых параметров:

1. coupon // купон по которому получена статистика;

2. offer_id // оффер ID на котором использован купон;

3. accessed // разрешен ли купон вебмастеру.

4. usage_data // данные об использовании купона;

5. coupon_data // данные купона в системе (см. API купонов).

Cakelink

Для получения полной ссылки по хешу, необходимо отправить GET-запрос на адрес:

https://cakelink.ru/{hash}?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Для получения полной ссылки по URL хешированной ссылки в GET-параметре, необходимо отправить GET-запрос на адрес:

https://cakelink.ru/link?link=https://go.acstat.com/{hash}&pass={API-key}

Для получения полной ссылки по дип линк, необходимо отправить GET-запрос на адрес:

https://cakelink.ru/link?dl={deeplink}&pass={API-key}

Примеры:

1. Получение полной ссылки с параметрами вебмастера для https://mvideo.ru/:

https://cakelink.ru/link?dl=https://mvideo.ru/&pass={API-key}

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

Нажмите, чтобы посмотреть пример ответа

{
"success":true,
"dt":"2021-10-12 14:58:44",
"data":{
    "url":"https://offer.ru/?utm_source=advcake&utm_medium=cpa&utm_campaign=affiliate&utm_content=s1&advcake_params=703e31c2bcd02fdf7bc5839064af8085&utm_term=703e31c2bcd02fdf7bc5839064af8085"
}
}

Описание получаемых параметров:

1. success // статус ответа success (true/false);

2. dt // дата и время запроса;

3. data // массив данных ответа;

4. url // полный URL со всеми GET-параметрами.

Бестселлеры

Для получения списка бестселлеров в формате JSON или XML, необходимо отправить GET-запрос на адрес:

https://api.advcake.com/bestseller?pass={API-key}

Примечание

При переходе по ссылке из личного кабинета все необходимые данные подставляются автоматически.

Дополнительно могут быть указаны следующие GET-параметры:

1. offer_id // отобразить бестселлеры для оффера с указанным ID;

2. date_from и date_to // посчитать кол-во проданных товаров в промежутке указанных дат (включительно). Формат дат: YYYY-MM-DD HH::II::SS;

3. min_count и max_count // отобразить бестселлеры проданные в количестве в промежутке (включительно);

4. min_wc и max_wc // отобразить бестселлеры c суммой комиссии в промежутке (включительно);

5. sort // задать сортировку по возможным значениям: count - количество товаров, wc - сумма комиссии (по умолчанию count);

6. offset // отобразить бестселлеры начиная с указанного порядкового номера;

7. limit // задать лимит выводимых бестселлеров (по умолчанию 100);

8. type // выбрать формат ответа JSON или XML (по умолчанию JSON).

Примеры:

1. Получить список бестселлеров по выбранному ID оффера:

https://api.advcake.com/bestseller?pass={API-key}&offer_id=240

2. Получить список бестселлеров с 1 января 2022 по текущую дату:

https://api.advcake.com/bestseller?pass={API-key}&date_from=2022-01-01%2000:00:00

3.Получить список бестселлеров с 14 по 21 февраля 2023 года включительно:

https://api.advcake.com/bestseller?pass={API-key}&date_from=2022-11-03%2000:00:00&date_to=2022-11-10%2023:59:59

4. Бестселлерами считать товары, которых продано больше 50:

https://api.advcake.com/bestseller?pass={API-key}&min_count=50

5. Бестселлерами считать товары, с комиссией от 500 руб:

https://api.advcake.com/bestseller?pass={API-key}&min_wc=500

6. Установить лимит на количество полученных бестселлеров равный 10:

https://api.advcake.com/bestseller?pass={API-key}&limit=10

7. Получить бестселлеры начиная с 5-го в списке:

https://api.advcake.com/bestseller?pass={API-key}&offset=5

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

Нажмите, чтобы посмотреть пример ответа

{
    "success": true,
    "date": "2020-10-12 13:56:33",
    "total": 1,
    "data": [
        {
            "id": 80289877,
            "offer_id": 23,
            "name": "Название товара",
            "url": "http://go.redav.online/896ad9f7474e19c0",
            "count": 1,
            "wc": 4027
        }
    ]
}

Описание получаемых параметров:

1. total // число бестселлеров, подходящих под запрос;

2. id // id товара в системе;

3. offer_id // id оффера;

4. nam // название товара;

5. url // партнерская ссылка;

6. count // кол-во проданных товаров;

7. wc // сумма комиссии.

Пример ответа об ошибке:

Нажмите, чтобы посмотреть пример ответа об ошибке

{
    "success": false,
    "dt": "2022-05-04 23:38:35",
    "warnings": {
        "date_from": [
            "Неверный формат значения «Date From»"
        ]
    }
}