#320: Купоны

Отредактирована: 11 дней назад

Список купонов

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	coupons	https://api.admitad.com/coupons/	Список параметров для запроса	Возвращает список купонов веб-мастера*
GET	coupons	https://api.admitad.com/coupons/{id}/		Возвращает купон для площадки, где id — это идентификатор купона*

* Возвращает результат в формате JSON.

Список параметров для запроса

Название	Тип	Допустимые значения
campaign	integer	Список партнерских программ
category	integer	Категории купонов
campaign_category	integer	Категории партнерских программ
type	integer
search	string	Поиск по названию и описанию купона, названию партнерской программы
date_start	date	%d.%m.%Y
date_end	date	%d.%m.%Y
offset	integer	Параметры limit, offset
limit	integer	Параметры limit, offset
order_by*	string	name
		rating
		date_start
		date_end
		Знак '-' перед значением означает обратный порядок. Например, order_by=-rating&order_by=date_start.
region	string	Регионы площадок
language	string	Системные языки
is_tracking_promocode	bool	Трекинговые купоны (is_tracking_promocode=true)
has_affiliate_link	bool	Трекинговые купоны с партнерской ссылкой (has_affiliate_link=true)
customer_type	string	Купоны доступны:
		только новым пользователям (customer_type=new_customers)
		всем пользователям (customer_type=all_customers)

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/?region=KZ&limit=1

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "status": "active",  
            "rating": "2.50",  
            "campaign": {  
                "id": 8,  
                "name": "Campaign_8",  
                "site_url": "http://example.com/"  
            },  
            "description": "description",  
            "short_name": "coupon",  
            "exclusive": false,  
            "date_end": "2018-07-25T23:59:59",  
            "date_start": "2018-11-10T00:00:00",  
            "id": 3,  
            "regions": [  
                "KZ"  
            ],  
            "language": "en",  
            "discount": "20%",  
            "types": [  
                {  
                    "id": 1,  
                    "name": "Type name 1"  
                },  
                {  
                    "id": 2,  
                    "name": "Type name 2"  
                }  
            ],  
            "image": "//cdn.admitad.com/media/campaign/images/2018/06/13/1d37869cf370a26b091f726cc4b24025.jpg",  
            "species": "promocode",  
            "categories": [  
                {  
                    "id": 1,  
                    "name": "Category name 1"  
                },  
                {  
                    "id": 2,  
                    "name": "Category name 2"  
                },  
            ],  
            "name": "Coupon1"  
        }  
    ],  
    "_meta": {  
        "count": 8,  
        "limit": 1,  
        "offset": 1  
    }  
}

Описание полей ответа API-сервера

Название	Описание
id	Идентификатор купона
name	Название купона
image	Изображение купона
status	Статус купона
rating	Рейтинг купона
description	Описание купона
campaign	Рекламная программа купона
date_start	Дата начала действия купона
date_end	Дата окончания действия купона (если значение поля — null, то купон бессрочный)
categories	Категории купонов
types	Типы купонов
exclusive	Эксклюзивный
discount	Скидка для купона (необязательное поле)
species	Разновидность купона ('promocode', 'action')
is_personal	Персональный промокод. Для отслеживания действий обязателен переход по партнерской ссылке.
is_unique	Уникальный промокод. Он не требует перехода по партнерской ссылке для отслеживания действий.
regions	Регионы площадок
language	Системные языки
is_tracking_promo_code	Трекинговый купон
has_affiliate_link	Трекинговый купон с партнерской ссылкой
customer_type	Купон доступен:
	только новым пользователям
	всем пользователям

Список купонов для площадки

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	coupons_for_website	https://api.admitad.com/coupons/website/{w_id}/	Список параметров для запроса	Возвращает список купонов для площадки, где w_id — это идентификатор площадки*
GET	coupons_for_website	https://api.admitad.com/coupons/{c_id}/website/{w_...		Возвращает купон для площадки, где w_id — это идентификатор площадки и c_id — это идентификатор купона*

* Возвращает результат в формате JSON.

Список параметров для запроса

Название	Тип	Допустимые значения
campaign	integer	Список партнерских программ
category	integer	Категории купонов
campaign_category	integer	Категории партнерских программ
type	integer
search	string	Поиск по названию и описанию купона, названию партнерской программы
date_start	date	%d.%m.%Y
date_end	date	%d.%m.%Y
offset	integer	Параметры limit, offset
limit	integer	Параметры limit, offset
region	string	Регионы площадок
		99 — фильтровать по регионам, подходящим площадке
language	string	Системные языки
order_by *	string	name
		rating
		date_start
		date_end
		Знак '-' перед значением означает обратный порядок. Например, order_by=-rating&order_by=date_start.
is_tracking_promocode	bool	Трекинговые купоны (is_tracking_promocode=true)
has_affiliate_link	bool	Трекинговые купоны с партнерской ссылкой (has_affiliate_link=true)
customer_type	string	Купоны доступны:
		только новым пользователям (customer_type=new_customers)
		всем пользователям (customer_type=all_customers)

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/website/22/?limit=1  

  
curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/1/website/22/?region=KZ

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "status": "active",  
            "rating": "2.50",  
            "date_start": "2018-11-10T00:00:00",  
            "campaign": {  
                "id": 8,  
                "name": "Campaign_8",  
                "site_url": "http://example.com/"  
            },  
            "short_name": "coupon",  
            "exclusive": false,  
            "name": "Coupon1",  
            "date_end": "2018-07-25T23:59:59",  
            "promocode": "PRABCABC",  
            "id": 3,  
            "regions": [  
                "KZ"  
            ],  
            "language": "en",  
            "discount": "20%",  
            "types": [  
                {  
                    "id": 1,  
                    "name": "Type name 1"  
                },  
                {  
                    "id": 2,  
                    "name": "Type name 2"  
                }  
            ],  
            "image": "//cdn.admitad.com/media/campaign/images/2018/06/13/1d37869cf370a26b091f726cc4b24025.jpg",  
            "frameset_link": "http://ad.admitad.com/coupon/292e71c4f659505879f503dd58751b/",  
            "goto_link": "http://ad.admitad.com/goto/4cd0ab308859505879f503dd58751b/",  
            "species": "promocode",  
            "categories": [  
                {  
                    "id": 1,  
                    "name": "Category name 1"  
                },  
                { 
                    "id": 2,  
                    "name": "Category name 2"  
                },  
            ],  
            "description": "description"  
        }  
    ],  
    "_meta": {  
        "count": 8,  
        "limit": 1,  
        "offset": 1  
    }  
}

Описание полей ответа API-сервера

Название	Описание
id	Идентификатор купона
name	Название купона
image	Изображение купона
status	Статус купона
rating	Рейтинг купона
description	Описание купонов
campaign	Рекламная программа купона
date_start	Дата начала действия купона
date_end	Дата окончания действия купона (если значение поля — null, то купон бессрочный)
categories	Категории купонов
types	Типы купонов
frameset_link	Ссылка на фреймсет с шапкой
goto_link	Прямая ссылка для перехода
promocode	Промокод
exclusive	Эксклюзивный
is_personal	Персональный промокод. Для отслеживания действий переходить по партнерской ссылке необязательно.
is_unique	Уникальный промокод. Он не требует перехода по партнерской ссылке для отслеживания действий.
discount	Скидка для купона (необязательное поле)
species	Разновидность купона ('promocode', 'action')
regions	Регионы площадок
language	Системные языки
is_tracking_promo_code	Трекинговый купон
has_affiliate_link	Трекинговый купон с партнерской ссылкой
customer_type	Купон доступен:
	только новым пользователям
	всем пользователям

Категории купонов

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	public_data	https://api.admitad.com/coupons/categories/	limit** *	Возвращает категории купонов*
			offset**
GET	public_data	https://api.admitad.com/coupons/categories/{id}/		Возвращает категорию купонов, где id — это идентификатор категории*

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например, limit=5&offset=2.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/categories/?limit=2

Пример ответа API-сервера в формате JSON:

{  
    "results": [  
        {  
            "name": "Category name 1",  
            "id": 1  
        },  
        {  
            "name": "Category name 2",  
            "id": 2  
        }  
    ],  
    "_meta": {  
        "count": 10,  
        "limit": 2,  
        "offset": 0  
    }  
}

Описание полей ответа API-сервера

Название	Описание
id	Идентификатор категории купона
name	Название категории купона