Проект

Общее

Профиль

Bug #128 » Описание_метода_получения_информации_о_прошивки.txt

Redmine Admin, 23.12.2024 06:56

 
1. Метод: получение информации о прошивки
1.1 адрес: https://api.devinoi.com/ustomer/device/:deviceTechnicalId
1.2 тип запроса: GET
1.3 параметры запроса:
path параметры:
deviceTechnicalId - строка, обязательный - технический Id устройства
1.4 авторизация: заголовок
Authorization: Bearer <secretKey>
secretKey - по аналогии с другими методами клиентской аторизации (через ручку refresh)
1.5 статусы ответов:
200 Ок;
400 BadRequest - если передан некорректный/пустой deviceTechnicalId;
401 Unauthorized - если передан некорректный Bearer secretKey;
404 Not Found - если передан deviceTechnicalId которого нет в базе;
500 Internal Server Error;
1.6 формат ответа (hit, 200 Ok):
1.6.1 тип контента: application/json
1.6.2 параметры объекта:
{
"versionName": "AppLOCALHOS-apk_v18.324812_DDDDD",
"versionNumber": "18.324812_DDDDDDD",
"versionType": "FULL",
"buildType": "RELEASE",
"mode": "FULL"
}
1.6.3 описание параметров:
versionName - строка, обязательный, имя версии устройства
versionNumber - строка, обязательный, версия прошивки устройства
versionType - строка (enum) не обязательный, значение по умолчанию - "" (пустая строка) возможные значения:
- FULL,
- LITE
mode - строка (enum) не обязательный, значение по умолчанию - "" (пустая строка) возможные значения:
- FULL
- LITE
buildType - строка (enum) не обязательный, значение по умолчанию - "" (пустая строка) возможные значения:
- RELEASE
- DEBUG
1.7 пример запроса:
curl --location 'https://api.devinoi.com/customer/device/a52fecd898cd5a4d' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9......'
(7-7/7)