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": "Upgrade notification content",
  "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": "Already latest version",
  "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": "No available version obtained",
  "docs": "No corresponding application version found, please confirm whether it has been correctly created in the system. Please refer to the documentation: https://upgrade.toolsetlink.com/en/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	서버 내부 데이터 확인 실패	문의해 주세요 연락처