Como lidar com assinaturas de API

Assinaturas de API são mecanismos de segurança que verificam a autenticidade e a integridade da requisição. Este guia demonstra como automatizar a geração de assinaturas no Apidog, eliminando a necessidade de recuperar assinaturas manualmente para cada requisição.

Estratégia de automação de assinaturas

Em vez de acessar manualmente um endpoint de assinatura antes de cada requisição, use os recursos de script do Apidog para:

Criar um script público que implemente a lógica de assinatura

Gerar assinaturas automaticamente usando parâmetros da requisição

Anexar assinaturas às requisições por meio de scripts ou variáveis de ambiente

Referenciar o script público nos pré-processadores de API

Abordagem de implementação

Método 1: Modificação direta por script

Adicione parâmetros de assinatura e modifique as informações da requisição diretamente por meio de scripts, sem usar variáveis de ambiente.

Vantagens:

Não há gerenciamento de variáveis de ambiente

Atualizações imediatas de parâmetros

Configuração mais simples

Método 2: Variáveis de ambiente

Gere a assinatura e grave-a em uma variável de ambiente; depois, referencie a variável nos parâmetros da API.

Vantagens:

Reutilizável em várias requisições

Depuração e monitoramento mais fáceis

Gerenciamento centralizado de assinaturas

Método 3: Programas externos

Para assinaturas implementadas em outras linguagens, use o método dog.execute para chamar programas externos.

Exemplo: assinatura baseada em MD5

Regras de geração de assinatura

Etapa 1: Criar a string de parâmetros

Colete todos os parâmetros não vazios no conjunto M

Classifique os parâmetros por código ASCII em ordem crescente (ordem de dicionário)

Concatene os parâmetros no formato de chave-valor de URL: key1=value1&key2=value2...

Resultado: stringA

Regras importantes:

Classifique os nomes dos parâmetros por código ASCII em ordem crescente

Valores de parâmetro vazios são excluídos da assinatura

Os nomes dos parâmetros diferenciam maiúsculas de minúsculas

O próprio parâmetro sign é excluído da assinatura

Etapa 2: Gerar a assinatura

Concatene a chave ao final de stringA para obter stringSignTemp

Aplique o algoritmo MD5 a stringSignTemp

Converta o resultado para letras maiúsculas para obter signValue

Implementação de script público

Exemplo: assinatura de API de tradução

Regras de geração de assinatura

Etapa 1: Concatenar a string

Concatene os seguintes valores em ordem:

appid: ID do aplicativo

q: Texto a ser traduzido (codificação UTF-8)

salt: Número aleatório

key: Chave atribuída pela plataforma (disponível no console de gerenciamento)

Resultado: appid + q + salt + key

Etapa 2: Gerar a assinatura

Aplique o algoritmo MD5 à string concatenada para obter uma assinatura de 32 bits em letras minúsculas.

Observações importantes:

O texto a ser traduzido (q) deve estar em codificação UTF-8

Ao concatenar appid+q+salt+key, NÃO aplique codificação de URL a q

Depois que a assinatura for gerada, aplique codificação de URL a q antes de enviar a requisição HTTP

Exemplo de requisição

Implementação de script público

Práticas recomendadas

Prática	Descrição
Use variáveis de ambiente	Armazene chaves confidenciais em variáveis de ambiente, não em scripts
Valide parâmetros	Verifique os parâmetros obrigatórios antes de gerar assinaturas
Registre logs para depuração	Use `console.log()` para depurar problemas de geração de assinatura
Trate casos extremos	Considere valores vazios, caracteres especiais e codificação
Centralize a lógica	Use scripts públicos para evitar duplicar a lógica de assinatura
Teste cuidadosamente	Verifique a geração de assinatura com casos de teste conhecidos

Como lidar com assinaturas de API

Estratégia de automação de assinaturas#

Abordagem de implementação#

Método 1: Modificação direta por script#

Método 2: Variáveis de ambiente#

Método 3: Programas externos#

Exemplo: assinatura baseada em MD5#

Regras de geração de assinatura#

Implementação de script público#

Exemplo: assinatura de API de tradução#

Regras de geração de assinatura#

Exemplo de requisição#

Implementação de script público#

Práticas recomendadas#

Estratégia de automação de assinaturas

Abordagem de implementação

Método 1: Modificação direta por script

Método 2: Variáveis de ambiente

Método 3: Programas externos

Exemplo: assinatura baseada em MD5

Regras de geração de assinatura

Implementação de script público

Exemplo: assinatura de API de tradução

Regras de geração de assinatura

Exemplo de requisição

Implementação de script público

Práticas recomendadas