API и интеграция

Сайт vkserfing.ru предоставляет доступ к функциям сайта посредством API. Для получения доступа к функциям сайта выполняется GET или POST запрос, где в качестве обязательного параметра должен передаваться token, ключ доступа к API, который предоставляется по запросу в тех. поддержку.

Например, для редактирования кампании и присвоения кампании статус "На паузе" потребуется выполнить следующий запрос:

https://vkserfing.ru/api/campaign.edit?token=a56a7e1c5358ee0c14c0e58d992da436&id=285259&status=pause

Смотря на запрос мы можем разбить его на следующие составляющие:

https://vkserfing.ru/api/ Базовый URL запроса, куда должны идти все вызовы
campaign.edit Вызываемый метод, где campaign - название ресурса, edit - метод ресурса.
token API-ключ, полученный у тех. поддержки
id и status Параметры вызываемого метода, в данном случае это ID редактируемой кампании и присваеваемый статус

Итого мы можем выделить основные составляющие запроса:

https://vkserfing.ru/api/[resource].[method]?token=[api_key]

В случае успешного выполнения, ответ будет выглядеть следующим образом:

 { status: 'success', data: "[data]" } 

В противном случае, придет следующее:

{ status: 'error', error: { code: "[code]", message: "[message]" } }
[code] Код ошибки
[message] Сообщение, описывающие эту самую ошибку
Методы
Campaign кампании
Метод Описание
campaign.add Создание кампании
campaign.edit Редактирование кампании
campaign.get Список всех кампаний
campaign.getById Информация о заданной кампании
campaign.logs Список пользователей выполнивших задание
Project папки проектов
Метод Описание
project.add Создание папки
project.edit Редактирование папки
project.delete Удаление папки
project.get Список всех папок
User пользователь
Метод Описание
user.balance Текущий баланс
Util вспомогательные методы
Метод Описание
util.getCountries Список стран
util.getCities Список городов
Ошибки

Ошибки делятся на 2 типа: общие и ошибки, характерные только для определенного метода. Ошибки методов будут представлены на странице оных, общие ошибки описаны здесь.

Код ошибки Описание
TOKEN_NOT_EXIST Переданный API ключ не существует
TOKEN_NOT_PASSED Не передан API ключ
TOKEN_BANNED_OWNER Владелец API ключа заблокирован
ARGUMENT_NOT_PASSED Не передан обязательный параметр
METHOD_NOT_EXIST Запрашиваемого метода не существует
RECORD_NOT_EXIST Запись с запрашиваемым ID не существует
INVALID_ARGUMENT_RANGE Неверное значение параметра. Значение должно удовлетворять условию минимума и максимума
INVALID_ARGUMENT_TYPE Неверный тип параметра (числовой, строковый)
INVALID_RANGE_CONDITION Неверное условие диапазона
INVALID_LENGTH Неверная длина строки параметра.
INVALID_ARGUMENT_VALUE Неверное значение. Значение может принимать одно из установленных
NOT_ENOUGH_MONEY Недостаточно средств на балансе
EXTERNAL_ERROR Внешняя ошибка
DATABASE_ERROR Ошибка базы данных
SERVER_ERROR Ошибка сервера