Веб сервисы
Материал из Hivext Wiki
Содержание |
Веб Сервисы
Веб-сервисы (далее Сервисы или API) - широкий спектр интуитивно понятных методов и функций часто использующихся при разработке веб-приложений и сайтов. Все сервисы размещены в вычислительном кластере.
Сервисы могут применяться для:
- Разработки веб приложений и сайтов;
- Разработки под социальные сети и мобильные устройства;
- Быстрой разработки прототипов.
Каждый сервис является самостоятельной строительной единицей, которую можно комбинировать с другими сервисами для получения необходимого результата.
Общая информация
API платформы разделено на две группы.
- HiAPI (High API) - сервисы высокого уровня, предоставляющие комплексную логику такую как регистрация, аутентификация, управление базой данных и другие сервисы.
- LoAPI (Local, Low API) - локальные функции низкого уровня, позволяющие взаимодействовать с веб-сервером.
Методы HiAPI можно вызывать как по сети (сетевой доступ по HTTP), так и локально (локальный доступ).
Методы LoAPI можно вызывать только локально.
Блок схема API
На схеме показаны:
- HiAPI (High API) - сервисы высокого уровня;
- LoAPI (Local, Low API) - локальные функции низкого уровня;
- Локальный доступ к LoAPI и HiAPI через глобальный объект hivext;
- Сетевой доступ к HiAPI по HTTP протоколу.
Локальный доступ
Обеспечивает доступ ко всем сервисам HiAPI и методам LoAPI из серверных скриптов Java, Javascript и других языков поддерживаемых сервисом Скриптинга. Этот вид доступа осуществляется через глобальный объект hivext который доступен в скриптах при условии их размещения через сервис Cкриптинга.
Локальный доступ к сервисам и методам производится без передачи данных по внешней сети.
Сетевой доступ
Обеспечивает удаленный доступ к HiAPI из серверов/клиентов созданных на любом языке программирования. Платформа предоставляет несколько протоколов высшего уровня работающих на базе HTTP.
| Язык программирования | Протокол доступа к сервису | Формат входящих параметров (кодирование) | Формат возвращаемых параметров (декодирование) |
|---|---|---|---|
| Все | HTTP/REST | urlEncoding, application/x-www-form-urlencoded | JSON |
| Все | SOAP | XML (SOAP 1.x) | XML (SOAP 1.x) |
| Специальные протоколы для языков программирования и сред | |||
| Javascript | CROSS (JSONP протокол для кросcдоменных запросов из Javascript) | urlEncoding, application/x-www-form-urlencoded | JSONP |
| Actionscript [flash, flex] | AMF (бинарный протокол от компании Adobe для Actionscript [flash, flex]) | AMF (AMF0, AMF3) | AMF (AMF0, AMF3) |
| Actionscript [flash, flex] | AMFX (XML протокол от компании Adobe для Actionscript [flash, flex]) | AMFX | AMFX |
Правила формирования адресов к методам сервисов
HiAPI - Базовые сервисы
Базовые сервисы для взаимодействия разработчика и пользователя с платформой.
HiAPI - Инфраструктурные сервисы
Инфраструктурные сервисы для взаимодействия разработчиков и приложений с платформой.
РазработкаКонтроль жизненного цикла приложений создаваемых на базе платформы (от генерации идентификаторов до удаления всех данных связанных с приложением). Размещение и выполнение скриптов и шаблонов на серверах платформы. |
УтилитыСервисы оптимизирующие взаимодействие с платформой. |
Система
| |
LoAPI - Локальное API
Локальное API предоставляет доступ к методам и функциям веб-сервера или ноды, которая в текущий момент активна для выполняемого скрипта. Методы доступны через глобальный объект hivext.local.имя_метода(параметры)
Методы | ||||
Примеры | ||||
