Создание площадок для сетей-партнеров
- Перед началом работы с API для сетей-партнеров попросите менеджера добавить метку «subnetwork» к вашему аккаунту веб-мастера в Admitad.
- Для использования метода нужно получить ключ доступа access_token. Описание авторизации
- В параметре scope нужно передавать название прав «manage_websites».
Параметры
HTTP-метод | Права доступа | URL | Примечание |
---|---|---|---|
POST | manage_websites | https://api.admitad.com/subnetworks/v1/websites/create/ |
|
Список параметров для запроса
Запрос принимает в body список json-объектов с параметрами площадки, которую нужно создать.
Название | Type | Обязательный | Ограничения параметров | Примечание, допустимые значения |
---|---|---|---|---|
name | string |
|
Максимальная длина 200 символов | |
url | string |
|
Максимальная длина 255 символов | |
category | array of integers |
|
Категории партнерских программ | |
region | array of strings |
|
Регионы площадок | |
native_kind | string |
|
Пример запроса для создания 3 площадок
curl -i -L -H 'Authorization: Bearer ${ACCESS_TOKEN_HERE}' -H "Content-Type: application/json" -X POST
http://api.admitad.loc/subnetworks/v1/create/ -d '[{ "name": "Test subnetwork with native 615125QCQ",
"native_kind":"social_network", "url": "https://google1.com/", "region": ["RU","BY"]}, { "name": "Test subnetwork with native 623225QQC", "native_kind":"social_network","url": "https://google1.com/",
"region": ["UA", "GB"]}, { "name": "Test subnetwork with native 73135QCQ",
"native_kind":"social_network", "url": "https://google1.com/", "category": [1,2,3], "region": ["US",
"CN"]}]'
Пример ответа при успешной обработке запроса
Если запрос обработан успешно, в качестве ответа будет возвращен json-объект с созданным ключом, где ключ — это индекс площадки, переданной в запросе, а значение — объект созданной площадки.
HTTP/1.1 200 OK
{
"0": {
"status": "active",
"kind": "subnetwork",
"is_old": false,
"account_id": "",
"verification_code": "8dfcc8fec5",
"creation_date": "2020-12-02T17:15:28",
"id": 349022,
"site_url": "https://google1.com/",
"validation_passed": false,
"name": "Test subnetwork with native 61",
"is_lite": false
},
"1": {
"status": "active",
"kind": "subnetwork",
"is_old": false,
"account_id": "",
"verification_code": "8c6210ac87",
"creation_date": "2020-12-02T17:15:28",
"id": 349023,
"site_url": "https://google1.com/",
"validation_passed": false,
"name": "Test subnetwork with native 62",
"is_lite": false
},
"2": {
"status": "active",
"kind": "subnetwork",
"is_old": false,
"account_id": "",
"verification_code": "a82bdc1022",
"creation_date": "2020-12-02T17:15:28",
"id": 349024,
"site_url": "https://google1.com/",
"validation_passed": false,
"name": "Test subnetwork with native 73",
"is_lite": false
}
}
Важно:
- Если хотя бы для одной из площадок сети-партнера в параметре передается невалидное значение, то запрос не будет обработан, и ни одна из площадок не будет создана.
- При успешном создании площадок будет создана отложенная задача на подключение всех созданных площадок сети-партнера ко всем партнерским программам, к которым подключена основная площадка сети-партнера. Для фактического подключения созданных площадок может потребоваться некоторое время (обычно не больше пары минут).
Пример ответа при невалидном запросе
Ответ будет возвращен в виде json-объекта.
HTTP/1.1 400 Bad Request
{
"0": {
"name": [
"У вас уже есть площадка с таким названием"
]
},
"1": {
"name": [
"У вас уже есть площадка с таким названием"
]
},
"2": {
"name": [
"У вас уже есть площадка с таким названием"
]
}
}
Пример ответа при частично невалидном запросе
HTTP/1.1 400 Bad Request
{
"0": "ok",
"1": "ok",
"2": {
"name": [
"У вас уже есть площадка с таким названием"
]
}
Статус подключения площадки сети-партнера к партнерской программе
- Перед началом работы с API для сетей-партнеров попросите менеджера добавить метку «subnetwork» к вашему аккаунту веб-мастера в Admitad.
- Для использования метода нужно получить ключ доступа access_token. Описание авторизации
- В параметре scope нужно передавать название прав «advcampaigns_for_website».
Параметры
HTTP-метод | Права доступа | URL | Примечание |
---|---|---|---|
GET | advcampaigns_for_website | http://api.admitad.loc/subnetworks/v1/advcampaign/${ADVCAMPAIGN_ID}/statuses/ |
|
- В параметре websites_id нужно передавать ID площадок, разделенные запятыми.
- Параметр websites_id не может содержать больше 30 ID площадок.
Пример запроса для получения статуса подключения площадки к программе
curl -L -H 'Authorization: Bearer ${ACCESS_TOKEN}' -X GET
https://api.admitad.com/subnetworks/v1/advcampaign/${ID_ADVCAMPAIGN}/statuses/\?
websites_id\=349001,349004
Пример ответа в формате JSON
HTTP/1.1 200 OK
[
{
"gotolink": "http://192.168.50.1:5000/g/xxmfo49zqsfbe235de1202e3d93061/?i=15",
"connection_status": "active",
"website_id": 349001,
"advcampaign_id": 15939
},
{
"gotolink": "",
"connection_status": "disabled",
"website_id": 349004,
"advcampaign_id": 15939
}
]