Возможности API рекламодателей

API	Описание
Статистика заказов	Получите список заказов в формате JSON.
Статистика визитов	Получите список визитов в формате JSON.
Валидация рефералов	Возможность валидации рефералов по email.

API со статистикой заказов

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

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

Примечание

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

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

date_from и date_to // отобразить заказы в промежутке указанных дат (включительно) формат дат: YYYY-MM-DD;
update_from и update_to // отобразить заказы, обновленные в промежутке указанных дат (включительно), формат дат: YYYY-MM-DD;
limit // установить лимит выводимых заказов (по умолчанию 5000 — максимальное значение);
offset // отобразить заказы, начиная с указанного порядкового номера, где 0 — последний заказ в списке;
order_ids // отобразить список заказов через запятую.

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

Примеры:

Получить список заказов с 4 по 11 января 2023 года включительно:

https://api.advcake.com/orders/advertiser/offer?pass={API-key}&date_from=2022-11-03&date_to=2022-11-10

Получить список заказов, обновленных с 4 по 11 января 2023 года включительно:

https://api.advcake.com/orders/advertiser/offer?pass={API-key}&update_from=2022-10-11&update_to=2022-11-10

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

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

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

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

Получить список заказов за август 2021, начиная с 5000 заказа:

https://api.advcake.com/orders/advertiser/offer?pass={API-key}&date_from=2021-08-01&date_to=2021-08-31&offset=5000

Получить список заказов с id 321 и 223:

https://api.advcake.com/orders/advertiser/offer?pass={API-key}&order_ids=321,223

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

{
"success":true,
"date":"2021-09-01 13:32:33",
"total":40,
"data": [
    {
        "order_id":"sde3988",
        "created_at":"2021-08-18 01:21:00",
        "updated_at":"2021-08-18 02:00:46",
        "status":"Одобрен",
        "partner":"affiliate",
        "webmaster":"fd7e5111",
        "price":37190,
        "commission_without_vat":534.58,
        "commission":641.5,
        "click_id":"46rlla7n3ly2sdle8gnqrocgegk1cygd",
        "platform":"android",
        "source_type":"sn_group,telegram",
        "client_type": "new"
    },
    {
        "order_id":"gfd67926",
        "created_at":"2021-08-18 11:58:00",
        "updated_at":"2021-08-18 13:00:54",
        "status":"Одобрен",
        "partner":"affiliate",
        "webmaster":"91dbf222",
        "price":780,
        "commission_without_vat":22.43,
        "commission":26.91,
        "click_id":"9lrZ1XwtA5ZEsPT",
        "drr":0.03,
        "platform":"ios",
        "source_type":"cashback",
        "client_type": "old"
    }
]
}

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

total // число заказов, подходящих под запрос;
order_id // id заказа;
created_at // дата заказа;
updated_at // дата обновления заказа;
status // статус заказа (Новый, Отменен, Одобрен);
partner // партнер заказа, обычно СРА-сеть;
webmaster // вебмастер заказа;
price // сумма заказа;
commission_without_vat //общая комиссия (без НДС);
commission // общая комиссия (с НДС);
click_id // clickId заказа
drr // ДРР — доля рекламных расходов, общая комиссия (с НДС) / сумма заказа;
platform // Платформа (ios, android, desktop);
source_type // Тип источника – alias (если несколько, то через запятую),
client_type // Тип клиента: new (новый) или old (старый).

Примечание

Полный список доступных столбцов вы можете найти в разделе «Заказы» в вашем личном кабинете.

Если в выгрузке вам не хватает данных – пожалуйста, сообщите нам.

API со статистикой визитов

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

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

Примечание

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

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

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

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

Примеры:

Получить список визитов с 4 по 11 января 2023 года включительно:

https://api.advcake.com/hits/advertiser/offer?pass={API-key}&date_from=2022-11-03&date_to=2022-11-10

Получить список визитов, для партнера Affiliate:

https://api.advcake.com/hits/advertiser/offer?pass={API-key}&partner=affiliate

Получить список визитов, для вебмастера advcake:

https://api.advcake.com/hits/advertiser/offer?pass={API-key}&partner=&webmaster=advcake

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

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

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

{
    "success":true,
    "date":"2021-09-01 13:32:33",
    "total":40,
    "data":[
        {
            "datetime":"2021-09-01 14:27:14",
            "offer_id":351,
            "session_id":"34fa4e4c-1d77-0be0-cf7b-76c92be5f3d6",
            "url":"https://www.1c-interes.ru/search/?page=2&SORT=POPULAR&SORT_ORDER=DESC&q",
            "refer":"",
            "data_partner":"",
            "partner":"",
            "webmaster":"",
            "track_type":"",
            "track_id":"e848b4f1-adec-d8b8-6a94-9615923c160a",
            "track_source":""
        },
        {
            "datetime":"2021-09-01 14:27:15",
            "offer_id":351,
            "session_id":"b9a91713-d07b-cdce-5fc7-006eb7036371",
            "url":"https://www.1c-interes.ru/",
            "refer":"https://www.google.com/",
            "data_partner":"91MZ1Wmb4PZAahp",
            "partner":"affiliate",
            "webmaster":"advcake",
            "track_type":"",
            "track_id":"8d49773e-cb1f-8620-8072-8e5c8a540e04",
            "track_source":""
        }
    ]
}

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

total // число визитов, подходящих под запрос;
datetime // время визита;
offer_id // ID оффера;
session_id // ID сессии;
url // url;
refer // url источника;
data_partner // уникальный ID клика;
partner // партнер;
webmaster // вебмастер;
track_type // тип модели оплаты;
track_id // track id;
track_source // track source.

API валидации рефералов

Для валидации рефералов по email, необходимо отправить GET-запрос на адрес:

https://api.advcake.ru/webmaster/validates?email=test@test.ru&pass={API-key}

Примечание

В параметре email укажите email реферала.

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

{
    "success": true,
    "dt": "2022-03-17 14:25:53",
    "just_created": true,
    "webmaster": "testweb",
    "status": "active",
    "api_key": "CR2hasddaDSD",
    "email": "test@test.ru",
    "person_type": "individual",
    "first_name": "Иван",
    "surname": "Иванович",
    "middle_name": "Иванов"
}

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

just_created // создан ли реферал;
webmaster // метка вебмастера;
status // статус реферала;
api_key // API ключ реферала;
person_type // тип вебмастера.