.. _uri_endpoint_reference:

Справочник URI эндпоинтов
=========================

После запуска сервера приложений по адресу ``http://server/{DATABASE}/`` становятся доступны следующие веб узлы:

===================  ===================================
Адрес                Описание
===================  ===================================
/                    Frontend приложения Global ERP
/webserver/          Backend приложения Global ERP
/fastreportmono/     Прокси к серверу FastReport Mono
/fastreport/         Прокси к серверу FastReport VCL 5
/ssh/                SSH сервер
/app/sys/            Системные :ref:`spec_services_http`
===================  ===================================

Ресурсы узла "/"
--------------------

- ``/login`` - страница входа.
- ``/view``  - ресурсы клиентского приложения.
- ``/ru.bitec.View`` - GWT-код клиентского приложения.

Ресурсы узла "/webserver"
----------------------------

- ``/EngineEndpoint`` - Используется как:
    - Web-сокет транспорта клиентского приложения
    - Url-адрес для получения коллекций изображений
        .. deprecated:: Для получения коллекций изображений используйте следующий :ref:`HTTP сервис<gs3_rest_image_collections>`
    - Url-адрес для получения ресурсов клиентского приложения
        .. deprecated:: Для получения ресурсов клиентского приложения используйте следующий :ref:`HTTP сервис<gs3_rest_resources>`
- ``/BrowserCmdEndpoint`` - Web-сокет транспорта браузерного плагина.
- ``/upload`` - адрес загрузки файлов на сервер.
- ``/download`` - адрес скачивания файлов с сервера.
- ``/sln`` - [Technical Preview] адрес обработчика http-запросов прикладного решения. Запросы направляются в экземпляр :java:type:`ru.bitec.gtk.core.servlet.CoreServlet`, полученный из :java:meth:`ru.bitec.gtk.core.servlet.CoreServletFactory.newInstance(Object)`

Параметры EngineEndpoint
+++++++++++++++++++++++++

.. _uri_endpoint_reference_get_image:

Получение коллекции изображений
*********************************

.. deprecated:: Для получения коллекций изображений используйте следующий :ref:`HTTP сервис<gs3_rest_image_collections>`

Параметры:

    - cmd = ``getImage``
    - sessionSecret = *Идентификатор сессии*
    - collectionName = *Наименование коллекции*

.. code-block::
    :caption: Пример запроса

    /webserver/EngineEndpoint?cmd=getImage&sessionSecret=3dd71af4-f800-4953-a36e-44b71b3e97c2&collectionName=toolbarprimarydisabled

.. seealso::
    - :ref:`Спецификация сервиса изображений - Общие положения <gs3_general_provisions>`
    - :ref:`Спецификация сервиса изображений - Коллекции изображений <gs3_images_image_collections>`

.. _uri_endpoint_reference_get_resource_image:

Получение изображения ресурсов прикладного проекта
****************************************************

.. deprecated:: Для получения ресурсов клиентского приложения используйте следующий :ref:`HTTP сервис<gs3_rest_resources>`

Параметры:

    - cmd = ``getResourceImage``
    - sessionSecret = *Идентификатор сессии*
    - resourceUri = *Путь к изображению относительно папки* ``resources``, которая хранится на прикладном проекте. Путь к папке ``resources``: ``КореньПроекта/Модуль/src/main/resources``.

.. code-block::
    :caption: Пример запроса

    /webserver/EngineEndpoint?cmd=getResourceImage&sessionSecret=3dd71af4-f800-4953-a36e-44b71b3e97c2&resourceUri=ru/bitec/app/gs3/images/0.svg

.. seealso::
    - :ref:`Спецификация сервиса изображений - Общие положения <gs3_general_provisions>`
    - :ref:`Спецификация сервиса изображений - Изображения ресурсов прикладного проекта <gs3_images_scala_images>`

Ресурсы узла "/app/sys"
----------------------------

- ``/monitor`` - Rest-сервисы мониторинга кластера:
    - ``/public/isAlive`` - информирует о доступности ноды.
    - ``/protected/nodes`` - возвращает список узлов кластера.
    - ``/protected/node`` - возвращает информацию об узле кластера.
    - ``/protected/sessions`` - управления рабочими сеансами пользователя.
    - ``/protected/session`` - управления рабочим сеансом пользователя.
- ``/soap``
- ``/ws/console``
- ``/resource`` - сервис ресурсов (пример: ExtComponent).
- ``/rest``
    - ``/report`` - сервис формирования печатных форм.
    - ``/reports`` - сервис формирования пачек печатных форм.
    - ``/es/pkg`` - точка доступа к прикладным RestPkg-пакетам и хранением состояния сессии (Exclusive Session).
    - ``/ss/pkg`` - точка доступа к прикладным RestPkg-пакетам и без хранения состояния сессии (Shared Session).