Адрес сервиса: https://adm.spotsnetwork.com/api/v2/

Спецификация

Обращение к сервису выполняется по протоколу JSON-RPC 2.0. Подробнее о спецификации протокола можете прочитать в официальных источниках.

Получение списка площадок

Для получения списка площадок необходимо вызвать метод "platform.getList".

Параметры запроса

Параметры объекта filter

В таблице ниже описаны все возможные параметры фильтрации.

Параметры ответа

В ответе будет возвращен массив объектов. Объекты содержат информацию о площадках по следующим полям:

• "id" - идентификатор площадки;
• "title" - название площадки;
• "advnet" - рекламная сеть;
• "advtitle" - название рекламной сети;
• "active" - статус площадки, возможны следующие варианты: 0 - неактивна, 1 - активна, 2 - заблокирована;
• "deleted" - флаг удаления: 0 - доступен, 1 - удален.

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

// пример запроса
{
    "jsonrpc": "2.0", 
    "method":"platform.getList", 
    "params":{}, 
    "id": 1
}
 
// пример ответа
{
	"jsonrpc":"2.0",
	"result":[
		{
			"title":"test_p2",
			"id":"673",
			"advnet":"adsn.demo",
			"active":"0",
			"deleted":"1",
			"advtitle":"adsn.demo"
		},
		{
			"title":"test",
			"id":"672",
			"advnet":"adsn.demo",
			"active":"0",
			"deleted":"1",
			"advtitle":"adsn.demo"
		}
	],
	"id":1
}

Получение списка категорий

Для получения списка категорий необходимо вызвать метод "platform.getСategories".

Параметры запроса

Вызов метода происходит без параметров.

Параметры ответа

В ответе будет возвращен массив объектов. Объекты содержат информацию о категориях по следующим полям:

• "id" - идентификатор категории;
• "title" - название категории;
• "index" - индекс категории.

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

// пример запроса
{
    "jsonrpc": "2.0", 
    "method":"platform.getСategories", 
    "params":{}, 
    "id": 1
}
 
// пример ответа
{
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "1",
            "title": "Искусство и Развлечения",
            "index": "01000000"
        },
        {
            "id": "1-1",
            "title": "Книги и литература",
            "index": "01010000"
        },
        {
            "id": "1-2",
            "title": "Celebrity Fan\/Gossip",
            "index": "01020000"
        },
        {
            "id": "1-3",
            "title": "Fine Art",
            "index": "01030000"
        }
    ],
    "id": 1
}

Создание площадки

Для создания новой площадки необходимо вызвать метод "platform.create".

Параметры запроса

Параметры объекта fields

В таблице ниже описаны поля, которые заполняются при создании новой площадки.

Параметры ответа

В ответе будет возвращен объект item и массив предупреждений warnings. Объект item содержит информацию о созданной площадке, включающую следующие поля:

• "id" - идентификатор площадки;
• "title" - название площадки;
• "siteurl" - домен площадки;
• "iabcat" - категория;
• "active" - статус площадки, возможны следующие варианты: 0 - неактивна, 1 - активна, 2 - заблокирована.

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

// пример запроса
{
    "jsonrpc": "2.0", 
    "method":"platform.create", 
    "params":{
        "fields": {
          "title": "Название", 
          "siteurl": "domain.ru", 
          "iabcat": ["1","25-1"]
        }
    }, 
    "id": 1
}
 
// пример ответа
{
    "jsonrpc": "2.0",
    "result": {
        "item": {
            "id": 5645,
            "title": "Название",
            "siteurl": "domain.ru",
            "iabcat": [
                "1",
                "25-1"
            ],
            "active": 0
        },
        "warnings": []
    },
    "id": 1
}

Обновление данных о площадке

Для обновления данных необходимо вызвать метод "platform.update".

Параметры запроса

Параметры объекта fields

В таблице ниже описаны поля, которые возможно обновить в площадке.

Параметры ответа

В ответе будет возвращен объект item и массив предупреждений warnings. Объект item содержит информацию о созданной площадке, включающую следующие поля:

• "id" - идентификатор площадки;
• "title" - название площадки;
• "siteurl" - домен площадки;
• "iabcat" - категория;
• "active" - статус площадки, возможны следующие варианты: 0 - неактивна, 1 - активна, 2 - заблокирована.

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

// пример запроса
{
    "jsonrpc": "2.0", 
    "method":"platform.update", 
    "params":{
        "id": 5645,
        "fields": {
          "active": 1, 
          "iabcat": ["1","25-2"]
        }
    }, 
    "id": 1
}
 
// пример ответа
{
    "jsonrpc": "2.0",
    "result": {
        "item": {
            "id": 5645,
            "title": "Название",
            "siteurl": "domain.ru",
            "iabcat": [
                "1",
                "25-2"
            ],
            "active": 1
        },
        "warnings": []
    },
    "id": 1
}