Получение офлайн-акций¶
Параметры¶
HTTP метод | Права доступа | URL | Параметры | Примечание |
---|---|---|---|---|
GET | offline_sales | https://api.admitad.com/offline_sales/ |
Список параметров для запроса | Возвращает список акций.*, |
GET | offline_sales | https://api.admitad.com/offline_sales/{id}/ |
Возвращает акцию.*, где id - это идентификатор акции. |
- * Возвращает результат в формате JSON.
Список параметров для запроса¶
Название | Тип | Допустимые значения |
---|---|---|
campaign | integer | Список партнёрских программ |
disabled | string |
|
datetime_start_from | datetime | %d.%m.%Y %H:%M |
datetime_start_to | datetime | %d.%m.%Y %H:%M |
datetime_end_from | datetime | %d.%m.%Y %H:%M |
datetime_end_to | datetime | %d.%m.%Y %H:%M |
datetime_created_from | datetime | %d.%m.%Y %H:%M |
datetime_created_to | datetime | %d.%m.%Y %H:%M |
limit | integer | Параметры limit, offset |
offset | integer | Параметры limit, offset |
is_activation_required | string |
|
Пример использования¶
Пример запроса с использованием утилиты curl:
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/offline_sales/?limit=1&disabled=false
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/offline_sales/3/
Пример ответа API-сервера в формате JSON:
{
"results": [
{
"campaign_id": 748,
"campaign_name": "foo campaign name",
"currency": "USD",
"description": "foo description",
"disabled": false,
"id": 3,
"image": "https://www.admitad.com/public/ceVbXte.jpg",
"name": "foo name",
"rate": "100.00",
"rate_type": "fixed",
"is_activation_required": true,
"datetime_start": "2018-10-11T15:53:54",
"datetime_end": "2018-11-09T15:53:54"
}
],
"_meta": {
"count": 3,
"limit": 1,
"offset": 0
}
}
Описание полей ответа API-сервера¶
Название | Описание |
---|---|
id | Идентификатор акции |
campaign_id | Идентификатор партнерской программы |
campaign_name | Наименование партнерской программы |
currency | Код валюты (ISO 4217) |
name | Наименование акции |
rate | Ставка |
datetime_start | Дата и время начала акции |
datetime_end | Дата и время завершения акции |
rate_type |
|
description | Условия акции |
image | Ссылка на изображение |
disabled |
|
is_activation_required |
|