API сервера

Обмен запросами с сервером мобильной платформой осуществляется с помощью HTTP API.

Перед началом использования методов API сервера ознакомьтесь с разделами: «Форматы для передачи данных на вход», «Специальные заголовки», «Обозначение версий дельты в запросах».

Для проверки доступности сервера мобильной платформы:

• выполните запрос с помощью API-метода status:

curl  "http://<IP-адрес или DNS-имя подготовленного сервера>/api/v1/status/"

• укажите адрес в строке браузера:

http://<IP-адрес или DNS-имя подготовленного сервера>/api/v1/status/

После выполнения одного из действий будет получена json-строка с результатом проверки доступности сервера мобильной платформы.

Результат при успешной проверке доступности и работы сервера мобильной платформы:

{"message":"Добро пожаловать на Форсайт. Мобильная платформа.","time":"2019-03-19T12:35:53.390324"}

Примечание. Проверка сервера мобильной платформы доступна без аутентификации.

API сервера, с которым может взаимодействовать разработчик:

• методы API, предназначенные для администратора:

• метод работы с названием инсталляции;

• метод управления лицензией;

• метод работы с учётными записями администраторов;

• метод работы с правами доступа учётной записи администратора;

• метод аутентификации администратора;

• метод работы с мобильными устройствами;

• метод работы с сертификатами шифрования;

• метод работы с настройками безопасности системы;

• метод управления паролями;

• метод работы с настройками LDAP;

• метод работы с настройками SMTP-сервера;

• метод работы с настройками Sentry;

• методы API, предназначенные для пользователя:

• метод получения текущей версии сервера и поддерживаемых версий API;

• метод проверки пароля на соответствие заданным требованиям;

• метод аутентификации пользователя API;

• метод смены пароля пользователя;

• метод работы с КриптоПро DSS;

• метод получения описания ресурсов;

• метод работы с табличными ресурсами;

• метод работы с транзакциями;

• методы работы с ресурсами файлового сервера;

• метод работы с кэшем;

• метод работы с логами;

• метод работы с push-уведомлениями;

• метод работы с JSON;

• метод работы с MS Exchange;

• метод работы с WEB-ресурсом.

Примечание. В настоящей версии мобильной платформы осуществляется поддержка версий API v0.6 и v0.7.

См. также:

Разработка