Основная информация

• Все запросы к сервису выполняются с помощью HTTP-методов GET и POST.
• Взаимодействие с сервисом должно осуществляться по защищённому протоколу HTTPS.
• Каждый запрос должен сопровождаться JWT-токеном.
• В каждом запросе клиент должен передавать ключ доступа в заголовке X-APIKey. Если ключ не передан или неверен, сервис возвращает ошибку HTTP 401.
• API ВКР-СМАРТ располагается и доступен по адресу http://localhost/{client_id}, где client_id — обязательный параметр для каждого запроса.

Аутентификация

Аутентификация производится посредством передачи токена безопасности с каждым запросом к сервису с помощью заголовка Authorization. Пример заголовка: Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGci...OjU4MTMsInRpbWUiOjE1Mjc1MTA2OTYOjU4MTM

JWT-токен подписывается алгоритмом HS256 ключевой фразой организации (secret_key) и должен содержать следующие данные:

• client_id — идентификатор организации-клиента ВКР-СМАРТ (должен совпадать с client_id в адресе запроса).
• time — время запроса от клиента (опционально).
• ip — IP-адрес клиента (значение может быть пустым, опционально).

Пример полезной нагрузки JWT:

{
    "client_id": 1,
    "time": 1725190000,
    "ip": ""
}

Описание запросов

Если указанный запрос не существует, сервис вернет ошибку HTTP 404, в ответе всегда будет содержаться сообщение.

Типовой успешный ответ:

{
    "success": true,
    "message": "",
    "total": 1,
    "status": 200,
    "data": {}
}

Типовой ответ об ошибке авторизации:

{
    "success": false,
    "message": "Приложение не авторизовано, проверьте заголовки"
}