4.1 Описание протокола
В качестве протокола обмена информацией используется протокол HTTP.
Используемые методы протокола HTTP: GET, POST.
Обработку запросов осуществляет приложение на web-сервере, предоставляющее доступ к API и работающий на платформе EOS Platform Host.
Допустим, приложение зарегистрировано по адресу https://delo.server.org/ (далее <адрес приложения>).
Обращения к API осуществляются через <адрес приложения>/CoreHost/<адрес контроллера>/<путь и параметры запроса>.
Для обработки запросов REST API, включая загрузку и скачивание файлов, доступен один контроллер по адресу:
- gql/query - для обработки запросов чтения и манипулирования объектами системы через GraphQL,
Все запросы на контроллер gql/query, как на чтение, так и на изменение данных идут через метод POST.
Запрос на загрузку файла gql/query - POST, запрос на чтение файла gql/query/download - GET.
Результат запроса (если не определено иное) будет представлен в виде объекта или массива объектов в формате JSON в теле ответа с Content-Type:application/json; charset=UTF-8.
Примеры формирования запросов написаны с использованием PowerShell
Запросы могут быть с параметрами и без параметров.
Создание сессии и закрытие сессии в системе «ДЕЛО» являются универсальными для ДЕЛО API 2009 (OData) и ДЕЛО API 2023 (GraphQL).
Описание и примеры кода см. 8.1. API входа в систему «ДЕЛО» и выхода из системы.