API de Detalhes da Versão do Aplicativo Windows
Descrição da API: Com base no número de versão do cliente, recuperar os detalhes da versão correspondente
📮Informações da Solicitação
URL da Solicitação
POST https://api.upgrade.toolsetlink.com/v1/win/version
Cabeçalhos da Solicitação
| Nome do Parâmetro | Obrigatório | Tipo | Valor de Exemplo | Descrição |
|---|---|---|---|---|
| X-Timestamp | Sim | string | 2025-02-17T10:34:55+08:00 | Hora da solicitação no formato RFC3339 |
| X-Nonce | Sim | string | fc812cc0b9b51e8c | String aleatória única (pelo menos 16 caracteres) |
| X-AccessKey | Sim | string | mui2W50H1j-OC4xD6PgQag | Chave secreta AccessKey |
| X-Signature | Sim | string | 3603437250c2df51fc46426ac79d8995 | Assinatura da solicitação Regras de Assinatura |
| Content-Type | Sim | string | application/json |
🔐 Mecanismo Anti-Ataque de Repetição
- O servidor verifica que a diferença de timestamp em relação ao tempo do servidor não excede ±5 minutos
- O servidor verifica se o valor Nonce já existe (para evitar solicitações duplicadas)
Corpo da Solicitação
json
{
"winKey": "isVZBUvkFhv6oHxk_X-D0Q",
"versionCode": 1,
"arch": "x64"
}Parâmetros do Corpo da Solicitação
| Nome do Parâmetro | Obrigatório | Tipo | Valor de Exemplo | Descrição |
|---|---|---|---|---|
| winKey | Sim | string | isVZBUvkFhv6oHxk_X-D0Q | Identificador único do aplicativo Windows |
| versionCode | Sim | int | 1 | Código de versão do cliente |
| arch | Sim | string | x64 | Arquitetura da máquina: x64, arm64 |
📮Informações da Resposta
Corpo da Resposta de Sucesso
json
{
"code": 200,
"msg": "Detalhes da versão encontrados",
"data": {
"winKey": "isVZBUvkFhv6oHxk_X-D0Q",
"packageName": "com.a.c",
"versionName": "v2",
"versionCode": 2,
"description": "Conteúdo da descrição",
"pubDate": "2024-02-17T10:34:55+08:00",
"arch": "x64",
"releaseNote": "Conteúdo das notas de lançamento",
"changelog": "Conteúdo do changelog",
"upgradeMode": 1,
"forcedUpgradeVersionCode": 1,
"silentUpgradeVersionCode": 1,
"target": "win",
"releaseUrl": "https://example.com/windows-app-v2.exe",
"updateType": "manual",
"md5": "valor md5",
"sha256": "valor sha256",
"downloadUrl": "https://example.com/windows-app-v2.exe",
"fileSize": 1024000,
"downloadTimes": 100,
"isPreRelease": false
}
}Parâmetros do Corpo da Resposta
| Nome do Parâmetro | Tipo | Valor de Exemplo | Descrição |
|---|---|---|---|
| winKey | string | isVZBUvkFhv6oHxk_X-D0Q | Identificador único do aplicativo Windows |
| packageName | string | com.a.c | Nome do pacote do aplicativo Windows |
| versionName | string | v2 | Nome da versão |
| versionCode | int | 2 | Código da versão |
| description | string | Conteúdo da descrição | Conteúdo da descrição |
| pubDate | string | 2024-02-17T10:34:55+08:00 | Data de publicação |
| arch | string | x64 | Arquitetura da máquina |
| releaseNote | string | Conteúdo das notas de lançamento | Notas de lançamento |
| changelog | string | Conteúdo do changelog | Changelog |
| upgradeMode | int | 1 | Modo de upgrade |
| forcedUpgradeVersionCode | int | 1 | Código de versão de upgrade forçado |
| silentUpgradeVersionCode | int | 1 | Código de versão de upgrade silencioso |
| target | string | win | Plataforma alvo |
| releaseUrl | string | https://example.com/windows-app-v2.exe | URL de lançamento |
| updateType | string | manual | Tipo de atualização |
| md5 | string | valor md5 | Soma de verificação MD5 |
| sha256 | string | valor sha256 | Soma de verificação SHA256 |
| downloadUrl | string | https://example.com/windows-app-v2.exe | URL de download |
| fileSize | int | 1024000 | Tamanho do arquivo (bytes) |
| downloadTimes | int | 100 | Contagem de downloads |
| isPreRelease | boolean | false | É versão pré-lançamento |
Corpo da Resposta de Erro Típica
json
{
"code": 404001,
"msg": "Nenhuma versão disponível encontrada",
"docs": "Nenhuma versão correspondente do aplicativo encontrada. Por favor, confirme se ela foi criada corretamente no sistema. Consulte a documentação: https://upgrade.toolsetlink.com/pt/upgrade/recommend/win/app-version.html",
"data": null
}📊Códigos de Status
| Código de Status HTTP | code | Descrição do Cenário | Solução |
|---|---|---|---|
| 200 | 200 | Detalhes da versão encontrados | |
| 200 | 0 | A versão atual é a mais recente | |
| 400 | 400001 | Solicitação inválida | |
| 400 | 400002 | Parâmetros ausentes | |
| 400 | 400003 | Parâmetros inválidos | |
| 400 | 400004 | Cabeçalho inválido | |
| 400 | 400005 | Corpo da solicitação inválido | |
| 401 | 401001 | Falha na autenticação | |
| 401 | 401002 | Falha na verificação de assinatura | |
| 404 | 404001 | Recurso não encontrado | |
| 404 | 404002 | Registro não encontrado | |
| 404 | 404003 | Método de processamento não encontrado | |
| 404 | 404004 | Solicitação não encontrada | |
| 500 | 500001 | Erro interno do servidor | Entre em contato Fale Conosco |
| 500 | 500002 | Falha na validação de dados interno do servidor | Entre em contato Fale Conosco |