#328: Площадки веб-мастера

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

Список площадок веб-мастера

Параметры

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

*** Фильтр по статусу площадки. Возможные значения:

new
active
suspended

*** Фильтр по статусу сотрудничества с площадкой. Возможные значения:

pending
active
declined
disabled

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

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

curl -L -H 'Authorization: Bearer access-token' -X GET https://api.admitad.com/websites/v2/

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

[  
    {  
        "status": "active",  
        "kind": "website",  
        "is_old": true,  
        "account_id": "",  
        "verification_code": "59505879f5",  
        "creation_date": "2010-03-31T18:25:19",  
        "id": 22,  
        "site_url": "http://www.test.ru/",  
        "validation_passed": false,  
        "name": "Site 1",  
        "is_lite": false  
    },  
    {  
        "status": "active",  
        "kind": "",  
        "is_old": true,  
        "account_id": "",  
        "verification_code": "bc76d01ad4",  
        "creation_date": "2010-03-31T18:25:38",  
        "id": 23,  
        "site_url": "http://www.test.ru/",  
        "validation_passed": false,  
        "name": "Site 2",  
        "is_lite": false  
    }  
]

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

Название	Описание
id	Идентификатор площадки
name	Название площадки
status	Статус площадки
creation_date	Дата создания площадки
site_url	Сайт площадки
verification_code	Код верификации
validation_passed	Маркер успешной валидации
is_old	Маркер старого типа
account_id	Идентификатор аккаунта
is_lite	Является ли площадка Lite-площадкой
kind	Типы площадок

Создание площадки веб-мастера

Этот API-метод более не поддерживается и был отключен. При обращении к нему возвращается статус 410 Gone. Документация сохранена в ознакомительных целях и скоро будет удалена.

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
POST	manage_websites	https://api.admitad.com/websites/v2/create/	Список параметров для запроса	Формат данных запроса application/json *
				Возвращает созданную площадку*

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

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

Название	Тип	Обязательный	Ограничения параметров	Примечание, допустимые значения
name	string	✔	max length - 200
kind	string	✔	max length - 20	Типы площадок ('social_network', 'traffic_purchase')
url	string		max length - 255
category	array of integers			Категории партнерских программ
region	array of strings			Регионы площадок

Пример данных для запроса

{  
    "name": "Test Website",  
    "kind": "social_network",  
    "url": "https://test.com",  
}

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

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

curl -L -H 'Authorization: Bearer access_token' -H "Content-Type: application/json" -X POST https://api.admitad.com/websites/v2/create/ -d '{ "name": "Test Website", "kind": "social_network", "url": "https://test.com" }'

Пример raw запроса:

POST /websites/v2/create/ HTTP/1.1  
User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3  
Host: api.admitad.com  
Accept: */*  
Authorization: Bearer access_token  
Content-Type: application/json  
{  
    "name": "Test Website",  
    "kind": "social_network",  
    "url": "https://test.com",  
}

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

{  
    "status": "active",  
    "kind": "social_network",  
    "is_old": false,  
    "account_id": "",  
    "verification_code": "d47d616e54",  
    "creation_date": "2020-02-06T16:22:46",  
    "id": 35,  
    "site_url": "",  
    "validation_passed": false,  
    "name": "Test Website",  
    "is_lite": false  
}

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

Название	Описание
id	Идентификатор площадки
name	Название площадки
status	Статус площадки
creation_date	Дата создания площадки
site_url	Сайт площадки
verification_code	Код верификации
validation_passed	Маркер успешной валидации
is_old	Маркер старого типа
account_id	Идентификатор аккаунта
is_lite	Является ли площадка Lite-площадкой
kind	Типы площадок

Изменение площадки веб-мастера

Параметры

HTTP метод	Права доступа	URL	Параметры	Примечание
POST	manage_websites	https://api.admitad.com/websites/v2/update/{id}/	Список параметров для запроса	Формат данных запроса application/json*
				Возвращает обновленную площадку, где id — это идентификатор площадки*

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

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

Название	Тип	Обязательный	Ограничения параметров	Примечание, допустимые значения
name	string		max length - 200
url	string		max length - 255

Пример данных для запроса

{  
    "name": "Test Website Updated",  
    "url": "https://updated.test/"  
}

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

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

curl -L -H 'Authorization: Bearer access_token' -H "Content-Type: application/json" -X POST https://api.admitad.com/websites/v2/update/63/ -d '{ "name": "Test Website Updated", "url": "https://updated.test/"}'

Пример raw запроса:

POST /websites/v2/update/63/ HTTP/1.1  
User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3  
Host: api.admitad.com  
Accept: */*  
Authorization: Bearer access_token  
Content-Type: application/json  

{
    "name": "Test Website Updated",  
    "url": "https://updated.test/"  
}

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

{  
    "status": "active",  
    "kind": "website",  
    "is_old": true,  
    "account_id": "",  
    "verification_code": "59505879f5",  
    "creation_date": "2010-03-31T18:25:19",  
    "id": 22,  
    "site_url": "https://updated.test/",  
    "validation_passed": false,  
    "name": "Test Website Updated",  
    "is_lite": false  
}

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

Название	Описание
id	Идентификатор площадки
name	Название площадки
status	Статус площадки
creation_date	Дата создания площадки
site_url	Сайт площадки
verification_code	Код верификации
validation_passed	Маркер успешной валидации
is_old	Маркер старого типа
account_id	Идентификатор аккаунта
is_lite	Является ли площадка Lite-площадкой
kind	Типы площадок

Подтверждение площадки веб-мастера

Параметры

HTTP метод	Права доступа	URL	Примечание
POST	manage_websites	https://api.admitad.com/websites/v2/verify/{id}/	Возвращает результат операции, где id — это идентификатор площадки*

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

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

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

curl -L -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/websites/v2/verify/8/

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

{  
    "message": "Ad space validated successfully.",  
    "success": "Accepted"  
}

Удаление площадки веб-мастера

Параметры

HTTP метод	Права доступа	URL	Примечание
POST	manage_websites	https://api.admitad.com/websites/v2/delete/{id}/	Возвращает результат операции, где id — это идентификатор площадки*

* Возвращает ответ со статусом 200 при успешном завершении операции.

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

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

curl -L -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/websites/v2/delete/8/

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

Название	Описание
id	Идентификатор площадки
name	Название площадки
status	Статус площадки
creation_date	Дата создания площадки
site_url	Сайт площадки
verification_code	Код верификации
validation_passed	Маркер успешной валидации
is_old	Маркер старого типа
account_id	Идентификатор аккаунта
is_lite	Является ли площадка Lite-площадкой
kind	Типы площадок