(Новая: api, удалённая регистрация, авторизация Под интеграцией в данной статье мы понимаем процесс объединен...) |
м (Защищена страница «Документация:Интеграция» [edit=sysop:move=sysop]) |
(нет различий)
|
Версия 13:47, 14 февраля 2009
api, удалённая регистрация, авторизация
Под интеграцией в данной статье мы понимаем процесс объединения информационной биллинговой системы JBs с использованием внешних веб-интерфейсов со сторонними информационными системами.
Описание интерфейса
Удалённый вызов функций системы JBs осуществляется с использованием протокола HTTP. Передача параметров может осуществляться как через GET так и через POST запросы. Обязательным для передачи всегда является параметр XMLHttpRequest=yes.
Ответы системы представлены в виде объектов формата JSON. Общий вид ответа выглядит следующим образом:
{Status:('Error','Exception','Ok'),Name1:Value1,Name2:Value2...}
Свойство Status присутствует во всех ответах системы и может принимать одно из трех указанных значений.
Виды ответа на запрос
- Если в процессе обработки запроса произошла ошибка (нет доступа к базе данных, ошибка работы с файловой системой и т.д.) - ответ системы будет выглядеть следующим образом:
{Status:'Error',Error:{CodeID:500,String:'Критическая ошибка'}}
- В случае, если в процессе обработки запроса произошло "исключение" (не верный формат входных данных, объект не найден в базе данных и т.д.) - ответ системы будет выглядеть как:
{Status:'Exception',Exception:{CodeID:'EXCEPTION_CODE',String:'Произошло исключение'}}
Исключение "ожидаемо", т.е. система уже была готова к тому что такая ситуация может произойти и среагировать на нее. Это отличает "исключения" от "ошибок". Каждый вызываемый модуль имеет свои исключения.
- Если системе успешно удалось обработать входящий запрос ответ будет следующим:
{Status:'Ok',Name1:Value1,Name2:Value2,...}
Ответ может содержать любые данные выдаваемые модулем.
Для удаленного вызова функций Вы в начале должны пройти авторизацию. |
Авторизация в системе
Авторизация - совокупность двух этапов: идентификации и авторизации. Идентификация в системе JBs происходит с использованием электронного адреса и пароля пользователя.