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.archive Получение архивных кампаний
Project
папки проектов
Метод Описание
project.add Создание папки проекта
project.edit Редактирование папки проекта
project.delete Удаление существующей папки
project.get Получение списка папок
User
пользователь
Метод Описание
user.balance Получение текущего баланса
Ошибки

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

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

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

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

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

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

{
    status: 'success',
    data: { id: 23432 }
}
Параметры
Название Описание
name Название кампании
type
обязательный параметр
Тип кампании.
Допустимые значения:
  • vk_community
  • vk_like
  • vk_share
  • vk_friends
  • vk_automatic_share
  • vk_automatic_like
project_id ID папки проектов
link
обязательный параметр
Ссылка на объект. Например, для кампании с типом "Добавить в друзья" это должна быть ссылка на профиль пользователя, которого необходимо добавлять в друзья
status
обязательный параметр
Статус кампании.
Допустимые значения:
  • active
  • pause
insurance Страховка.
При включении данной опции, в случаях санкций со стороны ВКонтакте к вашему сообществу, мы обязуемся компенсировать потраченные средства.
Допустимые значения:
  • on
  • off
adult Кампания содержит материалы для взрослых (18+).
Допустимые значения:
  • on
  • off
amount_users_limit_of_day Лимит исполнителей в день. Стандартное значение 480.
sex Пол аудитории.
Допустимые значения:
  • 0 - любой
  • 1 - мужской
  • 2 - женский
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 стран можно получить на странице API ВКонтакте
city Массив ID городов исполнителя
Список ID городов можно получить на странице API ВКонтакте
Ошибки
Название Описание
NOT_AVAILABLE Недостаточно прав для проведения операции. Возможно, вам была отключена возможность добавлять кампании.
INCORRECT_LINK Некорректная ссылка кампании. Ссылка должна ввести на ресурс vk.com и соотвествовать выбранному типу заданию: лайк - ссылка на пост, добавление в друзь - ссылка на пользователя и т.д.
EXIST_CAMPAIGN Похожая кампания уже была создана
BANNED_CAMPAIGN Похожая кампания была заблокирована
MODERATE_CAMPAIGNS У вас имеется 1 и больше модерируемых кампаний. Дождитесь прохождения модерации
NOT_EXIST_COMMUNITY Сообщество не найдено
DELETED_COMMUNITY Сообщество не найдено либо было удалено
REQUIRED_PUBLIC_COMMUNITY Сообщество должно быть открытым
REQUIRED_PHOTO_COMMUNITY У сообщества должна быть установлена главная фотография (аватарка)
REQUIRED_WALL_ITEMS_COMMUNITY На стене сообщества должно находиться минимальное количество записей
NOT_EXIST_USER Пользователь не найден
DELETED_USER Пользователь не найден, был удален либо заблокирован
Описание

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

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

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

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

{
    status: 'success',
    data: { edit: 'success' }
}
Параметры
Название Описание
name Название кампании
project_id ID папки проектов
status Статус кампании.
Допустимые значения:
  • active
  • pause
  • delete
amount_users_limit_of_day Лимит исполнителей в день
sex Пол аудитории.
Допустимые значения:
  • 0 - любой
  • 1 - мужской
  • 2 - женский
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 стран можно получить на странице API ВКонтакте
city Массив ID городов исполнителя
Список ID городов можно получить на странице API ВКонтакте
Ошибки
Название Описание
DELETE_CAMPAIGN Кампания была переведена в архив. Дальнейшее ее редактирование невозможно.
Описание

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

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

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

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

{
  "status": "success",
  "data": {
    "total": "1",
    "count": 1,
    "list": [
      {
        "id": "222580",
        "name": "",
        "type": "vk_friends",
        "insurance": "off",
        "adult": "off",
        "audience": "585479",
        "time": "2016-06-05 22:33:22",
        "status": "pause",
        "link": {
          "simple": "http://vk.com/id178212243",
          "direct": "http://vk.com/id178212243",
          "short": "http://goo.gl/3ovfF1"
        },
        "geo_targeting": {
          "sex": "0",
          "relation": "0",
          "age_from": "0",
          "age_to": "99",
          "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",
          "country": null,
          "city": null
        },
        "money": {
          "spent": "0",
          "per_user": "0.4"
        },
        "users": {
          "limit_total": "100",
          "limit_per_day": "480",
          "current": "1"
        },
        "project": null
      }
    ]
  }
}
Параметры ответа
Название Описание
count Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 10
offset Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0
Параметры ответа

Почти все параметры ответа описывают сами себя и не нуждаются в подробном описании, поэтому мы остановимся только на некоторых:

Название Описание
total Общее количество найденных постов. Используется для организации постраничного вывода результатов
count Количество возращаемых постов
money - spent Количество израсходованных средств
money - user Количество средств за одного исполнителя (за одно выполнение)
users - limit_total Требуемое количество исполнителей (сколько раз нужно выполнить задание)
users - limit_per_day Количество исполнителей в день
users - current Текущее количество исполнителей (выполненых заданий)
Описание

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

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

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

Добавляет папку проекта

В случае успешного выполнения вернет ответ с 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/assignment.get?token=a56a7e1rwr358ee0c14c0e58d992da436

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

{
  "status": "success",
  "data": {
    "total": 1,
    "count": 1,
    "list": [
      {
        "id": "183948",
        "type": "vk_community",
        "link": {
          "simple": "http://vk.com/justtravel_by",
          "direct": "http://vk.com/club107433186",
          "short": "http://goo.gl/XAWRbK"
        },
        "time": "2015-12-06 16:03:33",
        "adult": false,
        "price": "0.2"
      }
    ]
  }
}
Параметры запроса
Название Описание
count Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 10
offset Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0
Параметры ответа

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

Название Описание
time Дата и время создания кампании
adult По ссылке взрослый контент (18+)
price Цена за выполнение задания
Описание

Возвращает архивные (выполненые) задания.
Все параметры запроса и ответа схожи с методом assignment.get.

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

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

Возвращает нарушенные задания.
Все параметры запроса и ответа схожи с методом assignment.get.

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

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

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

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

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

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

{
    status: 'success',
    data: { balance: 100 }
}