Obter Estratégia de Upgrade do Aplicativo Android

Descrição da Interface: Obter a estratégia de upgrade correspondente com base no número de versão do cliente

📮Informações da Solicitação

URL da Solicitação

POST https://api.upgrade.toolsetlink.com/v1/apk/upgrade

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

1. O servidor verifica que a diferença de timestamp em relação ao tempo do servidor não excede ±5 minutos
2. O servidor verifica se o valor Nonce já existe (para evitar solicitações duplicadas)

Corpo da Solicitação

{
  "apkKey": "isVZBUvkFhv6oHxk_X-D0Q",
  "versionCode": 1,
  "appointVersionCode": 0,
  "devModelKey": "stv1",
  "devKey": "LOYlLXNy7w",
  "patchAlgo": 0
}

Descrição dos Parâmetros do Corpo da Solicitação

Nome do Parâmetro	Obrigatório	Tipo	Valor de Exemplo	Descrição
apkKey	Sim	string	isVZBUvkFhv6oHxk_X-D0Q	Identificador único do aplicativo Android
versionCode	Sim	int	1	Código de versão do cliente
appointVersionCode	Não	int	0	Código de versão de upgrade esperado, 0 ou não informado significa solicitar a versão mais recente
devModelKey	Não	string	stv1	Identificador único do modelo do dispositivo
devKey	Não	string	LOYlLXNy7w	Identificador único do dispositivo (pode usar MAC como identificador único)
patchAlgo	Não	int	0	Algoritmo de upgrade: 0: Upgrade completo; 1: Algoritmo HDiffPatch

📮Informações da Resposta

Corpo da Resposta de Sucesso

{
  "code": 200,
  "msg": "Nova versão obtida",
  "data": {
    "apkKey": "isVZBUvkFhv6oHxk_X-D0Q",
    "packageName": "com.a.c",
    "versionName": "v2",
    "versionCode": 2,
    "urlPath": "http://file.com/2.apk",
    "urlFileSize": 7213,
    "urlFileMd5": "36ee2a36b5d20d1008507d253423eea7",
    "patchAlgo": 0,
    "patchUrlPath": "http://file.com/1-2.patch",
    "patchUrlFileSize": 203,
    "patchUrlFileMd5": "36ee2a36b5d20d1008507d253423eea7",
    "upgradeType": 1,
    "promptUpgradeContent": "Conteúdo do prompt"
  }
}

Descrição dos Parâmetros do Corpo da Resposta

Nome do Parâmetro	Tipo	Valor de Exemplo	Descrição
apkKey	string	isVZBUvkFhv6oHxk_X-D0Q	Identificador único do aplicativo Android
packageName	string	com.a.c	Nome do pacote do aplicativo Android
versionName	string	v1	Nome da versão
versionCode	int	1	Código da versão
urlPath	string	http://file.com/2.apk	Endereço de download do arquivo
urlFileSize	int	7213	Tamanho do arquivo (bytes)
urlFileMd5	string	36ee2a36b5d20d1008507d253423eea7	MD5 do arquivo
patchAlgo	int	0	Algoritmo de upgrade: 0: Upgrade completo; 1: Algoritmo HDiffPatch
patchUrlPath	string	http://file.com/1-2.patch	Endereço de download do arquivo de patch
patchUrlFileSize	int	7213	Tamanho do arquivo de patch (bytes)
patchUrlFileMd5	string	36ee2a36b5d20d1008507d253423eea7	MD5 do arquivo de patch
upgradeType	int	1	Método de upgrade: 1: Upgrade com prompt; 2: Upgrade silencioso; 3: Upgrade forçado
promptUpgradeContent	string	Conteúdo do prompt	Conteúdo da descrição do upgrade com prompt

Corpo da Resposta de Erro Típica

{
  "code": 404001,
  "msg": "Nenhuma versão disponível obtida",
  "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/apk/app-version.html",
  "data": null
}

📊Códigos de Status

Código de status HTTP	code	Descrição do Cenário	Solução
200	0	Solicitação bem-sucedida, já é a versão mais recente
200	200	Solicitação bem-sucedida, estratégia de upgrade de versão obtida
400	400001	Solicitação ilegal
400	400002	Parâmetros ausentes
400	400003	Parâmetros ilegais
400	400004	Cabeçalho ilegal
400	400005	Corpo ilegal
401	401001	Falha na autenticação
401	401002	Falha na verificação de assinatura
404	404001	Recurso não encontrado
404	404002	Registro de consulta não encontrado
404	404003	Método de processamento não encontrado
404	404004	Solicitação não encontrada
429	429001	Limite de controle de fluxo de solicitação de estratégia de tarefa do aplicativo	A estratégia de controle de fluxo de solicitação para a tarefa de upgrade atual atingiu o limite, por favor, tente novamente mais tarde.
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