Мы предоставляем доступ к функциям сайта для заказчиков посредством API. Для получения доступа к функциям сайта выполняется GET или POST запрос, где в качестве обязательного параметра должен передаваться token, ключ доступа к API, который предоставляется по запросу в тех. поддержку.
API и интеграция
Например, для редактирования заказа и присвоения заказу статус "На паузе" потребуется выполнить следующий запрос:
https://vkserfing.com/api/campaign.edit?token=a56a7e1c5358ee0c14c0e58d992da436&id=285259&status=pause
Смотря на запрос мы можем разбить его на следующие составляющие:
| https://vkserfing.com/api/ | Базовый URL запроса, куда должны идти все вызовы |
| campaign.edit | Вызываемый метод, где campaign - название ресурса, edit - метод ресурса. |
| token | API-ключ, полученный у тех. поддержки |
| id и status | Параметры вызываемого метода, в данном случае это ID редактируемого заказа и присваеваемый статус |
Итого мы можем выделить основные составляющие запроса:
https://vkserfing.com/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 не существует |
| NOT_ENOUGH_MONEY | Недостаточно средств на балансе |
| EXTERNAL_ERROR | Внешняя ошибка |
| DATABASE_ERROR | Ошибка базы данных |
| SERVER_ERROR | Ошибка сервера |