На ряду с WEB-доступом к ресурсам Портала "Мультистат" существует так называемый API-доступ. Предлагаемый API-сервис – это набор функций, обеспечивающих интеграцию внешних программных комплексов с ресурсами Портала Мультистат.
Ниже приведена схема технологии работы с API-сервисом Портала "Мультистат":
{ZOOM_IMAGE}
По уровню работы с API-сервисом можно выделить следующие категории: API-агент и API-клиент (пользователь).
- API-агент – это фирма-поставщик программного обеспечения, обеспечивающего отправку запроса и обработку ответа API-сервиса Портала «Мультистат». Программное обеспечение (далее ПО) позволяет пользователю задать критерии запроса в максимально удобной и понятной форме, принимая на себя все заботы по формированию запросов к API-сервису портала установленной формы. Также ПО, предоставляемое API-агентом, преобразует ответ API-сервиса к виду, к нужному пользователю. Примером такого ПО может служить АС «CrossRequest», предоставляемый ООО «КроСистем» (http://crosys.ru/crossrequest.html).
- API-клиент (или пользователь) – конечный пользователь, зарегистрированный на Портале "Мультистат", использующий программное обеспечение API-агента, настроенное для доступа к API-сервису Портала.
Функции API-агента и API-клиента может выполнять одно предприятие (организация). Такая ситуация может возникнуть, если API-клиент использует собственные программные средства для доступа по API-сервису.
В натоящий момент доступны следующие API-функции:
- Тест соединения с API-сервисом
- Тест соединения API-агента
- Тест соединения пользователя через API-агента
- Информация об API-агенте
- Смена пароля API-агента
- Изменение регистрационной информации API-агента
- Авторизация API-пользователя
- Информация об API-пользователе
- Завершение авторизованного сеанса API-пользователя
- Информация о ресурсах, доступных по API
- Выборка информации по API-ресурсу
- Выборка списка справочников для API-ресурса
- Выборка позиций справочника API-ресурса
- Информация по API-запросу из хистори
Структура запроса и ответа зависит от конкретной API-функции. Для подробной информации см. Протокол API-сервиса.
На данный момент API-доступ может быть использован для получения информации по любому ресурсу группы Предприятия России:
|