|
Общие соглашения
Описание методов
Описание методов состоит из:
1. HTTP-method (GET, POST, DELETE) - идентифицирует действие
1.1.1. Базовые URL'ы
VCC-Server
Базовый URL для запросов http://vcc.megafonkavkaz.ru/vcc/rest/api/. То есть получить все центры можно по запросу http://vcc.megafonkavkaz.ru/vcc/rest/api/vcc
Conference Server
Базовый URL для этих запросов http://conf.megafonkavkaz.ru/conference/rest/api
«Личный секретарь»
Базовый URL для этих запросов http://sec.megafonkavkaz.ru/mas/app/json
Mobile Community «Мы вместе»
Базовый URL для этих запросов http://vmeste.megafonkavkaz.ru/community/app/json
Формат ответа
В результате выполнения метода возвращается объект-обертка из трех полей:
[{"response": { "status": 200, // Статусный код. Соответствует таким в Сообществе. "message": "OK", // Сообщение. Может содержать текст ошибки для отображения пользователю. "data": [ // Массив из объектов (или одного объекта) с запрашиваемыми данными. { ... } ] }}] |
Статусы
На данный момент в ответе поддерживаются следующие статусы
VCC-Server
API описывает интерфейс к услуге «Контактный центр», являющейся web-реализацией сервиса виртуального контактного центра (виртуального call-центра, VCC, ВЦОВ и т.п.). Общее абонентское описание услуги можно найти на сайте компании по адресу http://rostov.megafon.ru/services/base/callcenter.html
Разработчик получает доступ к API создания и редактирования сценариев работы виртуального звонкового центра.
Общее API
Аутентификация
Большинство методов требуют аутентификации пользователя, иначе будет возвращена ошибка с кодом 403.
GET
Path("/login")
QueryParam("login") - логин пользователя (полный MSISDN)
QueryParam("password") - пароль пользователя в Сервис-Гид
Вход в систему. Установятся 2 cookie, аналогично Сообществу.
GET
Path("/logout")
GET
Path("/me")
Получение информации о текущем пользователе в виде:
"data":[
{
"login": 1111, // логин пользователя
"securityItems": [{ // права пользователя в центрах
"permissions": ["AGENT"], // набор ролей (OWNER, ADMIN, AGENT)
"scope": "vcc", // константа, определяющая на что распространяются разрешения (сейчас только "vcc")
"scopeId": 11 // номер центра
}, {
"permissions": ["OWNER", "ADMIN"],
"scope": "vcc",
"scopeId": 1111
}]
}
]
Дата добавления: 2015-09-11; просмотров: 102 | Поможем написать вашу работу | Нарушение авторских прав |