Electron-приложение - Получение стратегии обновления

Описание API: Получение соответствующей стратегии обновления на основе номера версии клиента, совместимое с интерфейсом обновления, предоставленным официальной документацией Electron.

📮 Информация о запросе

URL запроса

GET http://0.0.0.0:8888/v1/electron/upgrade?electronKey=kPUtUMDIjBhS48q5771pow&versionName=1.1.1&appointVersionName=&devModelKey=&devKey=&platform=darwin&arch=arm64

Заголовки запроса

Название параметра	Обязательный	Тип	Пример значения	Описание
X-AccessKey	Да	string	mui2W50H1j-OC4xD6PgQag	Секретный ключ AccessKey

Параметры запроса

Название параметра	Обязательный	Тип	Пример значения	Описание
electronKey	Да	string	kPUtUMDIjBhS48q5771pow	Уникальный идентификатор Electron-приложения
versionName	Да	string	1.0.0	Номер версии
appointVersionName	Нет	string	1.2.0	Ожидаемое название версии обновления, по умолчанию последняя версия, если не указано
devModelKey	Нет	string	stv1	Уникальный идентификатор модели устройства
devKey	Нет	string	LOYlLXNy7w	Уникальный идентификатор устройства (можно использовать MAC-адрес как уникальный идентификатор)
platform	Да	string	linux	Операционная система: linux, darwin, windows
arch	Да	string	x64	Архитектура машины: x64, arm64

📮 Информация о ответе

Тело успешного ответа

{
  "upgradeType": 1,
  "promptUpgradeContent": "Содержимое уведомления об обновлении",
  "version": "1.2.0",
  "files": [
    {
      "url": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
      "sha512": "sNEx4hgG+cxFAULCDl9uOXJN+i4o/ND0adGphOP4Atbthvfmqb4uyLTENrrCyAIy0zaRxmFtI2aHiS/Da2uOyw==",
      "size": 153453614
    },
    {
      "url": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
      "sha512": "sNEx4hgG+cxFAULCDl9uOXJN+i4o/ND0adGphOP4Atbthvfmqb4uyLTENrrCyAIy0zaRxmFtI2aHiS/Da2uOyw==",
      "size": 153453614
    }
  ],
  "path": "https://api.upgrade.toolsetlink.com/v1/electron/download.AppImage?electronKey=kPUtUMDIjBhS48q5771pow&versionId=7",
  "sha512": "sSrgmnph5Cr2AuZwCEWXD90JiJ2JW0RnqLf8cXSxusHLssCPRlAFtpER74Rlw/LglbOlcYvh+IO3jsAxAdLQmw==",
  "releaseDate": ""
}

Тело успешного ответа (уже установлена последняя версия)

{
  "promptUpgradeContent": "Уже установлена последняя версия",
  "version": "1.0.0"
}

Когда система определяет, что запрошенная версия уже является последней, поле version вернет текущий запрошенный versionName.

Параметры тела ответа

Возвращаемое содержимое соответствует содержимому официально упакованного файла yml.

Название параметра	Тип	Пример значения	Описание
upgradeType	int		Тип уведомления об обновлении: 1: Обновление с подтверждением; 2: Тихое обновление; 3: Принудительное обновление
prompt_upgrade_content	string		Содержимое уведомления об обновлении
version	string		Номер версии
path	string		Путь загрузки файла обновления
sha512	string		Контрольная сумма sha512 файла обновления

Типичное тело ответа об ошибке

{
  "code": 404001,
  "msg": "Доступная версия не получена",
  "docs": "Соответствующая версия приложения не найдена, пожалуйста, подтвердите, была ли она правильно создана в системе. Пожалуйста, обратитесь к документации: https://upgrade.toolsetlink.com/ru/upgrade/recommend/tauri/app-version.html",
  "data": null
}

📊 Коды состояния

HTTP-код состояния	code	Описание сценария	Решение
200		Запрос успешен, получена стратегия обновления версии
400	400001	Недопустимый запрос
400	400002	Отсутствующий параметр
400	400003	Недопустимый параметр
400	400004	Недопустимый заголовок
400	400005	Недопустимое тело
401	401001	Неудачная аутентификация
401	401002	Неудачная проверка подписи
404	404001	Ресурс не найден
404	404002	Запись не найдена
404	404003	Метод обработки не найден
404	404004	Запрос не найден
429	429001	Ограничение частоты запросов стратегии задачи приложения	Достигнуто ограничение частоты запросов, настроенное для текущей задачи обновления, пожалуйста, попробуйте позже.
500	500001	Внутренняя ошибка сервера	Пожалуйста, свяжитесь с нами Связаться с нами
500	500002	Ошибка валидации данных сервера	Пожалуйста, свяжитесь с нами Связаться с нами