Tratamento de Assinaturas de API

As assinaturas de API são mecanismos de segurança que verificam a autenticidade e a integridade dos pedidos. Este guia demonstra como automatizar a geração de assinaturas no Apidog, eliminando a necessidade de obter manualmente assinaturas para cada pedido.

Estratégia de Automatização de Assinaturas

Em vez de aceder manualmente a um endpoint de assinatura antes de cada pedido, utilize as capacidades de scripting do Apidog para:

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

Gerar assinaturas automaticamente utilizando parâmetros do pedido

Anexar assinaturas aos pedidos através de scripts ou variáveis de ambiente

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

Abordagem de Implementação

Método 1: Modificação Direta do Script

Adicione parâmetros de assinatura e modifique as informações do pedido diretamente através de scripts, sem utilizar variáveis de ambiente.

Vantagens:

Sem gestão 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 escreva-a numa variável de ambiente; em seguida, referencie a variável nos parâmetros da API.

Vantagens:

Reutilizável em vários pedidos

Depuração e monitorização mais fáceis

Gestão centralizada de assinaturas

Método 3: Programas Externos

Para assinaturas implementadas noutras linguagens, utilize o método dog.execute para chamar programas externos.

Exemplo: Assinatura Baseada em MD5

Regras de Geração de Assinatura

Passo 1: Criar a cadeia de parâmetros

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

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

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

Resultado: stringA

Regras importantes:

Ordene os nomes dos parâmetros por código ASCII em ordem ascendente

Os valores de parâmetros 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

Passo 2: Gerar a assinatura

Concatene a chave no final de stringA para obter stringSignTemp

Aplique o algoritmo MD5 a stringSignTemp

Converta o resultado para maiúsculas para obter signValue

Implementação do Script Público

Exemplo: Assinatura de API de Tradução

Regras de Geração de Assinatura

Passo 1: Concatenar a cadeia

Concatene os seguintes valores por ordem:

appid: ID da aplicação

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

salt: Número aleatório

key: Chave atribuída pela plataforma (disponível na consola de gestão)

Resultado: appid + q + salt + key

Passo 2: Gerar a assinatura

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

Notas importantes:

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

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

Depois de a assinatura ser gerada, aplique codificação URL a q antes de enviar o pedido HTTP

Exemplo de Pedido

Implementação do Script Público

Boas Práticas

Prática	Descrição
Utilizar Variáveis de Ambiente	Armazene chaves sensíveis em variáveis de ambiente, não em scripts
Validar Parâmetros	Verifique a existência de parâmetros obrigatórios antes de gerar assinaturas
Registar para Depuração	Utilize `console.log()` para depurar problemas de geração de assinaturas
Tratar Casos-Limite	Tenha em conta valores vazios, caracteres especiais e codificação
Centralizar a Lógica	Utilize scripts públicos para evitar duplicar a lógica de assinatura
Testar Exaustivamente	Verifique a geração de assinaturas com casos de teste conhecidos

Tratamento de Assinaturas de API

Estratégia de Automatização de Assinaturas#

Abordagem de Implementação#

Método 1: Modificação Direta do 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 do Script Público#

Exemplo: Assinatura de API de Tradução#

Regras de Geração de Assinatura#

Exemplo de Pedido#

Implementação do Script Público#

Boas Práticas#

Estratégia de Automatização de Assinaturas

Abordagem de Implementação

Método 1: Modificação Direta do 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 do Script Público

Exemplo: Assinatura de API de Tradução

Regras de Geração de Assinatura

Exemplo de Pedido

Implementação do Script Público

Boas Práticas