Configuração - Obter Estratégia de Upgrade
Descrição da API: Com base no número de versão do cliente, recuperar a estratégia de upgrade correspondente
📮 Informações da Requisição
URL da Requisição
POST https://api.upgrade.toolsetlink.com/v1/configuration/upgrade
Cabeçalhos da Requisição
| Nome do Parâmetro | Obrigatório | Tipo | Valor de Exemplo | Descrição |
|---|---|---|---|---|
| X-Timestamp | Sim | string | 2025-02-17T10:34:55+08:00 | Horário da requisiçã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 requisição Regras de Assinatura |
| Content-Type | Sim | string | application/json |
🔐 Mecanismo Anti-reprodução de Ataques
- O servidor verifica que o timestamp difere do horário do servidor em no máximo ±5 minutos
- O servidor verifica se o valor Nonce já existe (para evitar requisições duplicadas)
Corpo da Requisição
json
{
"configurationKey": "q1hfB1VUQaK9VksTZGPU1Q",
"versionCode": 1,
"appointVersionCode": 0,
"devModelKey": "stv1",
"devKey": "LOYlLXNy7w"
}Parâmetros do Corpo da Requisição
| Nome do Parâmetro | Obrigatório | Tipo | Valor de Exemplo | Descrição |
|---|---|---|---|---|
| configurationKey | Sim | string | q1hfB1VUQaK9VksTZGPU1Q | Identificador único da configuração |
| versionCode | Sim | int | 1 | Código da versão registrado no sistema |
| appointVersionCode | Não | int | 2 | Código da versão esperada do upgrade, passe 0 ou omita para solicitar a versão mais recente |
| devModelKey | Não | string | stv1 | Identificador único do modelo do dispositivo |
| devKey | Não | string | 89c8b3d5f2a74e1b | Identificador único do dispositivo (pode usar endereço MAC como identificador único) |
📮 Informações da Resposta
Corpo da Resposta Bem-sucedida
json
{
"code": 200,
"msg": "Nova versão obtida",
"data": {
"configurationKey": "q1hfB1VUQaK9VksTZGPU1Q",
"versionName": "v2",
"versionCode": 2,
"upgradeType": 1,
"promptUpgradeContent": "Conteúdo do prompt",
"content": {
"test": 1
}
}
}Parâmetros do Corpo da Resposta
| Nome do Parâmetro | Tipo | Valor de Exemplo | Descrição |
|---|---|---|---|
| configurationKey | string | q1hfB1VUQaK9VksTZGPU1Q | Identificador único da configuração |
| versionName | string | v1 | Nome da versão |
| versionCode | int | 1 | Código da versão |
| upgradeType | int | 1 | Método de upgrade: 1: Upgrade por prompt; 2: Upgrade silencioso; 3: Upgrade forçado |
| promptUpgradeContent | string | Código otimizado | Conteúdo da descrição do upgrade por prompt |
| content | string | Conteúdo é o json configurado no sistema |
Corpo da Resposta de Erro Típica
json
{
"code": 404001,
"msg": "Nenhuma versão disponível obtida",
"docs": "Nenhuma versão correspondente da aplicação encontrada, por favor confirme se foi corretamente criada no sistema. Por favor, consulte a documentação: https://upgrade.toolsetlink.com/pt/upgrade/recommend/url/app-version.html",
"data": null
}📊 Códigos de Status
| Código de Status HTTP | Código | Descrição do Cenário | Solução |
|---|---|---|---|
| 200 | 0 | Requisição bem-sucedida, atualmente na versão mais recente | |
| 200 | 200 | Requisição bem-sucedida, estratégia de upgrade de versão obtida | |
| 400 | 400001 | Requisição inválida | |
| 400 | 400002 | Parâmetro ausente | |
| 400 | 400003 | Parâmetro inválido | |
| 400 | 400004 | Cabeçalho inválido | |
| 400 | 400005 | Corpo inválido | |
| 401 | 401001 | Falha na autenticação | |
| 401 | 401002 | Falha na verificação da assinatura | |
| 404 | 404001 | Recurso não encontrado | |
| 404 | 404002 | Registro não encontrado | |
| 404 | 404003 | Método de processamento não encontrado | |
| 404 | 404004 | Requisição não encontrada | |
| 500 | 500001 | Erro interno do servidor | Entre em contato conosco Fale Conosco |
| 500 | 500002 | Falha na verificação de dados interno do servidor | Entre em contato conosco Fale Conosco |