API.md

VK TAG API

Основное

Каждый запрос должен содержать в себе vk_user_id -- идентификатор пользователя Если идентификатор не передается, система вернёт ошибку вида:

{"status":"error","msg":"You must be authorized"}

Методы

Получение метки

@GET(/)

Поле	Описание
hash = null	Идентификатор метки

Если поле hash не передается, система вернёт все метки, для которых vk_user_id является админом Например:

{"status":"success","tags":[
{"id":1,"admin_vk_user_id":1232,"hash":"test_1","type":"friend_add","data":9878,"title":"Название тестовой метки"},
{"id":4,"admin_vk_user_id":1232,"hash":"test_2","type":"group_join","data":9878,"title":"Название второй метки"},
...
]}

Если передано поле hash, система вернёт ответ метки Например:

{"status":"success","tag":{"type":"friend_adds","data":9878}}

Создание метки

@INSERT(/)

Поле	Описание
hash	Идентификатор метки
type	Тип события
data	Возвращаемые данные

Если не были переданы необходимые для создания метки данные, система вернёт ошибку вида:

{"status":"error","msg":"Empty hash passed"}

Если метка уже существует, система вернёт ошибку вида:

{"status":"error","msg":"Tag is already exists"}

Редактирование метки

@POST(/)

Поле	Описание
hash	Идентификатор метки
type	Тип события
data	Возвращаемые данные

Если метка не пренадлежит админу или не существует, система вернёт ошибку вида:

{"status":"error","msg":"You can't modify tag"}

Удаление метки

@DELETE(/)

Поле	Описание
hash	Идентификатор редактируемой метки

Если метка не пренадлежит админу или не существует, система вернёт ошибку вида:

{"status":"error","msg":"You can't delete tag"}