Обмен запросами с сервером мобильной платформой осуществляется с помощью HTTP API версий v0.6 и v0.7. На сервере мобильной платформы доступна спецификация API для ознакомления с методами и их использованием.
Для открытия спецификации API укажите адрес в строке подключения:
https://<IP-адрес или DNS-имя сервера>/api/swagger-ui/#/
После выполнения действия будет открыт список методов API:
Перед началом использования методов API ознакомьтесь с разделами: «Форматы для передачи данных на вход», «Специальные заголовки», «Обозначение версий дельты в запросах».
Для проверки доступности сервера мобильной платформы выполните одно из действий:
выполните запрос с помощью API-метода status:
curl "http://<IP-адрес или DNS-имя подготовленного сервера>/api/v1/status/"
укажите адрес в строке браузера:
http://<IP-адрес или DNS-имя подготовленного сервера>/api/v1/status/
После выполнения одного из действий будет получена json-строка с результатом проверки доступности сервера мобильной платформы.
Результат при успешной проверке доступности и работы сервера мобильной платформы:
{"message":"Добро пожаловать на Форсайт. Мобильная платформа.","time":"2024-02-01T07:03:30.813660"}
Примечание. Проверка сервера мобильной платформы доступна без аутентификации.
API сервера, с которым может взаимодействовать разработчик:
методы API, предназначенные для администратора:
методы API, предназначенные для пользователя:
См. также: