Cистема активной раскрутки и заработка в социальных сетях

934032
vkserfing
vkserfing@gmail.com
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.archive Список архивных кампаний
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 Ошибка сервера
Описание

Создает рекламную кампанию.
В случае успешного выполнения вернет ответ с ID созданной кампании.

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

https://vkserfing.ru/api/campaign.add?token=a56a7e1rwr358ee0c14c0e58d992da436&link=http://vk.com/club31231231&type=vk_community&status=active

Пример запроса с указанием нескольких значений городов и семейного положения:

https://vkserfing.ru/api/campaign.add?token=a56a7e1rwr358ee0c14c0e58d992da436&link=http://vk.com/club31231231&type=vk_community&relation[]=1&relation[]=2&city[]=1&city[]=2

Пример ответа:

{
    status: 'success',
    data: { id: 23432 }
}
Параметры
Название Описание
name Название
type
обязательный параметр
Тип задания.
Может принимать следующие значения:
  • vk_community - ВК: Вступить в сообщество
  • vk_share - ВК: Рассказать друзьям (+ лайк)
  • vk_like - ВК: Поставить лайк
  • vk_friends - ВК: Добавить в друзья
  • vk_automatic_share - ВК: Автоматические репосты + лайки
  • vk_automatic_like - ВК: Автоматические лайки
project_id ID папки
link
обязательный параметр
Ссылка на задание.
status
обязательный параметр
Статус кампании.
Может принимать следующие значения:
  • active - запустить
  • pause - на паузу
insurance Страховка.
При включении данной опции, в случаях санкций со стороны ВКонтакте к вашему сообществу, мы обязуемся компенсировать потраченные средства.
Может принимать следующие значения:
  • on - включена
  • off - выключена
По умолчанию - off.
adult Материалы для взрослых (18+).
Может принимать следующие значения:
  • on - содержит
  • off - не содержит
По умолчанию - off.
amount_users_limit
обязательный параметр
Количество исполнителей.
amount_users_limit_of_day Лимит исполнителей в сутки.
По умолчанию - 480
amount_users_limit_random Варьировать количество исполнителей
По умолчанию - on
Допустимые значения:
  • on - включено
  • off - выключено
Только для типов заданий vk_automatic_share и vk_automatic_like
amount_automatic_records_limit Количество новых постов (лимит, определяющий сколько заданий будет создано)
0 - без ограничений
Только для типов заданий vk_automatic_share и vk_automatic_like
sex Пол аудитории.
Может принимать следующие значения:
  • 0 - любой
  • 1 - женский
  • 2 - мужской
По умолчанию - 0
relation Семейное положение. Передается в виде массива.
Может принимать следующие значения:
  • 0 - любое
  • 1 - не женат / не замужем
  • 2 - есть друг / есть подруга
  • 3 - помолвлен / помолвлена
  • 4 - женат / замужем
  • 5 - все сложно
  • 6 - в активном поиске
  • 7 - влюблен / влюблена
По умолчанию - 0
Можно указать несколько значений
age_from Минимальный возраст исполнителя
По умолчанию - 0
age_to Максимальный возраст исполнителя
По умолчанию - 999
friends_from Минимальное количество друзей у исполнителя
По умолчанию - 0
friends_to Максимальное количество друзей у исполнителя
По умолчанию - 9999
photos_profile_from Минимальное количество фотографий профиля у исполнителя
По умолчанию - 0
photos_profile_to Максимальное количество фотографий профиля у исполнителя
По умолчанию - 999
wall_items_from Минимальное количество записей на странице исполнителя
По умолчанию - 0
wall_items_to Максимальное количество записей на странице исполнителя
По умолчанию - 99999
from_time_reg_vk_month Минимальное количество месяцев с момента регистрации исполнителя
По умолчанию - 0
country ID страны исполнителя
Список ID стран можно получить методом util.getCountries
city ID городов исполнителя. Передается в виде массива
Список ID городов можно получить на util.getCities
Можно указать до 50 городов
Ошибки
Название Описание
NOT_AVAILABLE Недостаточно прав для проведения операции. Возможно, вам была отключена возможность создавать кампании
INCORRECT_LINK Некорректная ссылка кампании. Ссылка должна начинаться с https://vk.com и соотвествовать выбранному типу задания
EXIST_CAMPAIGN Такая кампания уже существует
BANNED_CAMPAIGN Такая кампания заблокирована
MODERATE_CAMPAIGNS У вас есть кампании на модерации, для создания новых необходимо дождаться их рассмотрения
USER_THIS_CAMPAIGN_ON У вас уже имеется такая же запущенная кампания
ALL_THIS_CAMPAIGN_ON В базе всех кампаний уже имеется такая же запущенная кампания
NOT_EXIST_COMMUNITY Такого сообщества не существует
DELETED_COMMUNITY Такого сообщества не существует или удалено
REQUIRED_PUBLIC_COMMUNITY Сообщество должно быть открытым
REQUIRED_PHOTO_COMMUNITY У сообщества должна быть установлена главная фотография (аватарка)
REQUIRED_WALL_ITEMS_COMMUNITY В сообществе должно быть не менее 5 записей
NOT_EXIST_USER Такого пользователя не существует
DELETED_USER Такого пользователя не существует либо он удален или заблокирован
NOT_AVAILABLE_WALL_ITEM Чтобы создать задание, в настройках приватности страницы https://vk.com/settings?act=privacy (страницы, относящейся к указываемой записи) в параметре "Кому в интернете видна моя страница" установите значение "Всем"
NOT_AVAILABLE_PHOTO_ITEM Фото не существует или скрыто настройками приватности или находится в папке "Сохраненные фотографии"
USERS_LIMIT Достигнут лимит исполнителей для этой кампании
NEW_RECORDS_LIMIT Достигнут лимит количества новых записей
WRONG_CITY Один из передаваемых городов не найден либо не соответствует указанной стране. Все города должны быть из соответствующей страны
Описание

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

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

https://vkserfing.ru/api/campaign.edit?token=a56a7e1rwr358ee0c14c0e58d992da436&id=12313&status=pause&name=Моя+измененная+кампания

Пример ответа:

{
    status: 'success',
    data: { edit: 'success' }
}
Параметры
Название Описание
name Название
project_id ID папки
status Статус кампании.
Допустимые значения:
  • on - запустить
  • pause - на паузу
  • delete - в архив
amount_users_limit Количество исполнителей
amount_users_limit_of_day Лимит исполнителей в сутки
amount_users_limit_random Варьировать количество исполнителей
Допустимые значения:
  • on - включено
  • off - выключено
Только для типов заданий vk_automatic_share и vk_automatic_like
amount_automatic_records_limit Количество новых постов (лимит, определяющий сколько заданий будет создано)
0 - без ограничений
Только для типов заданий vk_automatic_share и vk_automatic_like
sex Пол аудитории.
Может принимать следующие значения:
  • 0 - любой
  • 1 - женский
  • 2 - мужской
relation Семейное положение.
Может принимать следующие значения:
  • 0 - любое
  • 1 - не женат / не замужем
  • 2 - есть друг / есть подруга
  • 3 - помолвлен / помолвлена
  • 4 - женат / замужем
  • 5 - все сложно
  • 6 - в активном поиске
  • 7 - влюблен / влюблена
Можно указать несколько значений
age_from Минимальный возраст исполнителя
age_to Максимальный возраст исполнителя
friends_from Минимальное количество друзей у исполнителя
friends_to Максимальное количество друзей у исполнителя
photos_profile_from Минимальное количество фотографий профиля у исполнителя
photos_profile_to Максимальное количество фотографий профиля у исполнителя
wall_items_from Минимальное количество записей на странице исполнителя
wall_items_to Максимальное количество записей на странице исполнителя
from_time_reg_vk_month Минимальное количество месяцев с момента регистрации исполнителя
country ID страны исполнителя
Список ID стран можно получить методом util.getCountries
city ID городов исполнителя
Список ID городов можно получить методом util.getCities
Можно указать до 50 городов
Ошибки
Название Описание
DELETE_CAMPAIGN Кампания была переведена в архив. Ее дальнейшее редактирование невозможно
Описание

Получение списка кампаний.

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

https://vkserfing.ru/api/campaign.get?token=a56a7e1rwr358ee0c14c0e58d992da436

Пример ответа:

{
  "status": "success",
  "data": {
    "total": 1,
    "count": 1,
    "list": [
      {
        "id": "363187",
        "name": "ere",
        "type": "vk_community",
        "insurance": "off",
        "link": "https://vk.com/public23414124",
        "adult": "off",
        "time": "2018-06-05 19:31:13",
        "status": "pause",
        "targeting": {
          "sex": "0",
          "relation": "0",
          "age_from": "0",
          "age_to": "999",
          "friends_from": "0",
          "friends_to": "9999",
          "photos_profile_from": "0",
          "photos_profile_to": "999",
          "wall_items_from": "0",
          "wall_items_to": "99999",
          "month_reg_period": "0",
          "limit_per_day": "480",
          "automatic_records_limit": "0",
          "country": {
            "id": "1",
            "name": "Россия"
          },
          "city": null
        },
        "money": {
          "spent": "5",
          "per_user": "0.5"
        },
        "users": {
          "limit_total": "100",
          "current": "10",
          "limit_system_per_hour": "20",
          "users_limit_random": "off"
        },
        "project": null
      }
    ]
  }
}
Параметры запроса
Название Описание
count Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 10
offset Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0
type Тип заданий.
Может принимать следующие значения:
  • vk_community - ВК: Вступить в сообщество
  • vk_share - ВК: Рассказать друзьям (+ лайк)
  • vk_like - ВК: Поставить лайк
  • vk_friends - ВК: Добавить в друзья
  • vk_automatic_share - ВК: Автоматические репосты + лайки
  • vk_automatic_like - ВК: Автоматические лайки
project_id ID папки. Выводит задания которые вложены в указанную папку
status Статус фильтруемых кампании.
Допустимые значения:
  • on - активные задания
  • pause - задания на паузе
insurance Страховка. Возможные значения
  • on - включена
  • off - выключена
По умолчанию - off.
adult Материалы для взрослых (18+).
Может принимать следующие значения:
  • on - включен режим 18+
  • off - выключен
По умолчанию - off.
amount_users_from Минимальное значение человек которое выполнило задания
amount_users_to Максимальное значение человек которое выполнило задания
time_from Минимальная дата создания задания. Формат YYYY-MM-DD HH:MI:SS
time_to Максимальная дата создания задания. Формат YYYY-MM-DD HH:MI:SS
Параметры ответа
Название Описание
total Общее количество найденных результатов. Используется для организации постраничного вывода
count Количество возращаемых результатов
list -> id ID кампании
list -> name Название
list -> type Тип задания.
Может принимать следующие значения:
  • vk_community - ВК: Вступить в сообщество
  • vk_share - ВК: Рассказать друзьям (+ лайк)
  • vk_like - ВК: Поставить лайк
  • vk_friends - ВК: Добавить в друзья
  • vk_automatic_share - ВК: Автоматические репосты + лайки
  • vk_automatic_like - ВК: Автоматические лайки
list -> insurance Страховка.
Может принимать следующие значения:
  • on - включена
  • off - выключена
list -> adult Материалы для взрослых (18+).
Может принимать следующие значения:
  • on - содержит
  • off - не содержит
list -> time Дата создания кампании.
list -> status Статус кампании.
Может принимать следующие значения:
  • on или wait_on или wait_on_available - активна
  • pause - на паузе
  • moderated - на модерации
  • banned - заблокирована
list -> link Ссылка на задание
list -> targeting -> sex Пол аудитории.
Может принимать следующие значения:
  • 0 - любой
  • 1 - женский
  • 2 - мужской
list -> targeting -> relation Семейное положение.
Может принимать следующие значения:
  • 1 - не женат / не замужем
  • 2 - есть друг / есть подруга
  • 3 - помолвлен / помолвлена
  • 4 - женат / замужем
  • 5 - все сложно
  • 6 - в активном поиске
  • 7 - Влюблен / влюблена
list -> targeting -> age_from Минимальный возраст исполнителя
list -> targeting -> age_to Максимальный возраст исполнителя
list -> targeting -> friends_from Минимальное количество друзей у исполнителя
list -> targeting -> friends_to Максимальное количество друзей у исполнителя
list -> targeting -> photos_profile_from Минимальное количество фотографий профиля у исполнителя
list -> targeting -> photos_profile_to Максимальное количество фотографий профиля у исполнителя
list -> targeting -> wall_items_from Минимальное количество записей на странице исполнителя
list -> targeting -> wall_items_to Максимальное количество записей на странице исполнителя
list -> targeting -> month_reg_period Минимальное количество месяцев с момента регистрации исполнителя
list -> targeting -> limit_per_day Лимит исполнителей в сутки
list -> targeting -> automatic_records_limit Количество новых постов
0 - без ограничений Только для типов заданий vk_automatic_share и vk_automatic_like
list -> money -> spent Израсходовано средств
list -> money -> per_user Стоимость одного исполнителя
list -> users -> limit_total Количество исполнителей
list -> users -> limit_system_per_hour Системная скорость исполнителей в час
list -> users -> current Текущее количество выполнений
list -> users -> users_limit_random Варьировать количество исполнителей
Значения:
  • on - включено
  • off - выключено
Только для типов заданий vk_automatic_share и vk_automatic_like
list -> project -> id ID папки
list -> project -> name Название папки
Описание

Получение информации о кампании по ее ID.

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

https://vkserfing.ru/api/campaign.getById?token=a56a7e1rwr358ee0c14c0e58d992da436&id=41531414

Пример ответа:

{
  "status": "success",
  "data": {
    "id": "321612312",
    "name": "",
    "type": "vk_friends",
    "insurance": "off",
    "adult": "off",
    "time": "2017-12-31 15:04:11",
    "status": "pause",
    "link": "https://vk.com/id1",
    "targeting": {
      "sex": "0",
      "relation": "0",
      "age_from": "0",
      "age_to": "999",
      "friends_from": "0",
      "friends_to": "9999",
      "photos_profile_from": "0",
      "photos_profile_to": "999",
      "wall_items_from": "0",
      "wall_items_to": "99999",
      "month_reg_period": "0",
      "automatic_records_limit": "0",
      "country": null,
      "city": null
    },
    "money": {
      "spent": "0",
      "per_user": "0.3"
    },
    "users": {
      "limit_total": "100",
      "current": "10",
      "limit_system_per_hour": "20",
      "users_limit_random": "off"
    },
    "project": null
  }
}
Параметры запроса
Название Описание
id ID кампании
Параметры ответа

Все параметры ответа схожи с параметрами метода campaign.get для отдельно взятой кампании.

Описание

Получение списка архивных (удаленных) кампаний.
Все параметры запроса и ответа схожи с методом campaign.get.

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

https://vkserfing.ru/api/campaign.archive?token=a56a7e1rwr358ee0c14c0e58d992da436
Описание

Возвращает список пользователей выполнивших задание.

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

https://vkserfing.ru/api/campaign.logs?token=a56a7e1rwr358ee0c14c0e58d992da436&campaign_id=898932

Пример ответа:

{
  "status": "success",
  "data": {
    "total": 2,
    "count": 2,
    "list": [
      {
        "log_id": "59277342",
        "user_id": "28133441228",
        "first_name": "Роман",
        "last_name": "Иванов",
        "photo": "https://pp.userapi.com/c625522/v6255222328/f305/aNOxxW7zix2Y.jpg?ava=1",
        "time": "2018-07-01 09:44:27"
      },
      {
        "log_id": "59277318",
        "user_id": "17042250191",
        "first_name": "Аня",
        "last_name": "Федорова",
        "photo": "https://pp.userapi.com/c418822/u17050191/d_1bba425312.jpg?ava=1",
        "time": "2018-07-01 09:42:39"
      }
    ]
  }
}
Параметры запроса
Название Описание
count Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 10
offset Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0
Параметры ответа

Все параметры ответа описывают сами, поэтому разберем только часть из них.

Название Описание
total Общее количество найденных результатов. Используется для организации постраничного вывода
count Количество возращаемых результатов
list -> [] -> log_id ID выполнения
list -> [] -> time Время выполнения задания
Описание

Создает папку проекта.

В случае успешного выполнения вернет ответ с ID созданной папки.

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

https://vkserfing.ru/api/project.add?token=a56a7e1rwr358ee0c14c0e58d992da436&name=Моя+папка

Пример ответа:

{
    status: 'success',
    data: { id: 143 }
}
Параметры
Название Описание
name Название папки
Ошибки
Название Описание
EXIST_NAME Данное название папки уже существует
Описание

Редактирует папку проекта.

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

https://vkserfing.ru/api/project.edit?token=a56a7e1rwr358ee0c14c0e58d992da436&id=312&name=Моя+измененная+папка

Пример ответа:

{
    status: 'success',
    data: { edit: 'success' }
}
Параметры
Название Описание
id
обязательный параметр
ID папки
name Название папки
Ошибки
Название Описание
EXIST_NAME Данное название папки уже существует
Описание

Удаляет папку проекта.

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

https://vkserfing.ru/api/project.delete?token=a56a7e1rwr358ee0c14c0e58d992da436&id=312

Пример ответа:

{
    status: 'success',
    data: { delete: 'success' }
}
Параметры
Название Описание
id
обязательный параметр
ID папки
Описание

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

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

https://vkserfing.ru/api/project.get?token=a56a7e1rwr358ee0c14c0e58d992da436

Пример ответа:

{
  "status": "success",
  "data": {
    "total": 3,
    "count": 3,
    "list": [
      {
        "id": "214",
        "name": "qqq2",
        "time": "2017-12-17 18:38:56",
        "status": "on",
        "campaigns": [
          "285259"
        ]
      },
      {
        "id": "217",
        "name": "qqq1",
        "time": "2017-12-18 04:56:03",
        "status": "on",
        "campaigns": null
      },
      {
        "id": "218",
        "name": "qqq",
        "time": "2017-12-18 04:56:40",
        "status": "on",
        "campaigns": null
      }
    ]
  }
}
Параметры запроса
Название Описание
count Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 10
offset Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0
Параметры ответа

Все параметры ответа описывают сами, поэтому разберем только часть из них.

Название Описание
total Общее количество найденных результатов. Используется для организации постраничного вывода
count Количество возращаемых результатов
time Дата и время создания папки
campaigns Массив ID кампаний, входящих в папку
Описание

Возвращает текущее состояние баланса.

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

https://vkserfing.ru/api/user.balance?token=a56a7e1rwr358ee0c14c0e58d992da436

Пример ответа:

{
    status: 'success',
    data: { balance: 100 }
}
Описание

Возвращает список стран.

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

https://vkserfing.ru/api/util.getCountries?token=a56a7e1rwr358ee0c14c0e58d992da436&name=Аз

Пример ответа:

{
  "status": "success",
  "data": [
    {
      "id": "5",
      "name": "Азербайджан"
    },
    {
      "id": "4",
      "name": "Казахстан"
    }
  ]
}
Параметры запроса
Название Описание
id Поиск по ID страны
name Поиск по названию страны
Описание

Возвращает список городов.

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

https://vkserfing.ru/api/util.getCities?token=a56a7e1rwr358ee0c14c0e58d992da436&name=Мос

Пример ответа:

{
  "status": "success",
  "data": {
    "total": 2,
    "count": 2,
    "list": [
      {
        "id": "1",
        "name": "Москва",
        "country": {
          "id": "1",
          "name": "Россия"
        }
      },
      {
        "id": "964",
        "name": "Новомосковск",
        "country": {
          "id": "1",
          "name": "Россия"
        }
      }
    ]
  }
}
Параметры запроса
Название Описание
count Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 20
offset Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0
id Поиск по ID города
name Поиск по названию города. Ищет включение входной строки в названиях городов.
country Поиск по стране. Параметр может принимать как ID страны, так и ее название.
Параметры ответа

Все параметры ответа описывают сами, поэтому разберем только часть из них.

Название Описание
total Общее количество найденных результатов. Используется для организации постраничного вывода
count Количество возращаемых результатов
list -> [] -> country Информация о стране соотвествующего города: id, название