Gestión de firmas de API

Las firmas de API son mecanismos de seguridad que verifican la autenticidad e integridad de las peticiones. Esta guía demuestra cómo automatizar la generación de firmas en Apidog, eliminando la necesidad de recuperar manualmente las firmas para cada petición.

Estrategia de automatización de firmas

En lugar de acceder manualmente a un endpoint de firma antes de cada petición, utilice las capacidades de scripting de Apidog para:

Crear un script público que implemente la lógica de firma

Generar firmas automáticamente utilizando parámetros de la petición

Adjuntar firmas a las peticiones mediante scripts o variables de entorno

Hacer referencia al script público en los preprocesadores de API

Enfoque de implementación

Método 1: Modificación directa mediante script

Añada parámetros de firma y modifique la información de la petición directamente mediante scripts sin utilizar variables de entorno.

Ventajas:

No se requiere gestión de variables de entorno

Actualizaciones inmediatas de parámetros

Configuración más sencilla

Método 2: Variables de entorno

Genere la firma y escríbala en una variable de entorno; luego haga referencia a la variable en los parámetros de la API.

Ventajas:

Reutilizable en múltiples peticiones

Depuración y supervisión más sencillas

Gestión centralizada de firmas

Método 3: Programas externos

Para firmas implementadas en otros lenguajes, utilice el método dog.execute para llamar a programas externos.

Ejemplo: firma basada en MD5

Reglas de generación de firmas

Paso 1: Construir la cadena de parámetros

Recopile todos los parámetros no vacíos en el conjunto M

Ordene los parámetros por código ASCII en orden ascendente (orden de diccionario)

Concatene los parámetros en formato clave-valor de URL: key1=value1&key2=value2...

Resultado: stringA

Reglas importantes:

Ordene los nombres de los parámetros por código ASCII en orden ascendente

Los valores de parámetros vacíos se excluyen de la firma

Los nombres de parámetros distinguen entre mayúsculas y minúsculas

El propio parámetro sign se excluye de la firma

Paso 2: Generar la firma

Concatene la clave al final de stringA para obtener stringSignTemp

Aplique el algoritmo MD5 a stringSignTemp

Convierta el resultado a mayúsculas para obtener signValue

Implementación del script público

Ejemplo: firma de API de traducción

Reglas de generación de firmas

Paso 1: Concatenar la cadena

Concatene los siguientes valores en orden:

appid: ID de la aplicación

q: Texto que se traducirá (codificación UTF-8)

salt: Número aleatorio

key: Clave asignada por la plataforma (disponible en la consola de administración)

Resultado: appid + q + salt + key

Paso 2: Generar la firma

Aplique el algoritmo MD5 a la cadena concatenada para obtener una firma en minúsculas de 32 bits.

Notas importantes:

El texto que se traducirá (q) debe estar en codificación UTF-8

Al concatenar appid+q+salt+key, NO aplique codificación URL a q

Después de generar la firma, aplique codificación URL a q antes de enviar la petición HTTP

Ejemplo de petición

Implementación del script público

Mejores prácticas

Práctica	Descripción
Utilice variables de entorno	Almacene claves sensibles en variables de entorno, no en scripts
Valide los parámetros	Compruebe los parámetros obligatorios antes de generar firmas
Registre para depurar	Utilice `console.log()` para depurar problemas de generación de firmas
Gestione casos límite	Tenga en cuenta valores vacíos, caracteres especiales y codificación
Centralice la lógica	Utilice scripts públicos para evitar duplicar la lógica de firma
Pruebe exhaustivamente	Verifique la generación de firmas con casos de prueba conocidos

Gestión de firmas de API

Estrategia de automatización de firmas#

Enfoque de implementación#

Método 1: Modificación directa mediante script#

Método 2: Variables de entorno#

Método 3: Programas externos#

Ejemplo: firma basada en MD5#

Reglas de generación de firmas#

Implementación del script público#

Ejemplo: firma de API de traducción#

Reglas de generación de firmas#

Ejemplo de petición#

Implementación del script público#

Mejores prácticas#

Estrategia de automatización de firmas

Enfoque de implementación

Método 1: Modificación directa mediante script

Método 2: Variables de entorno

Método 3: Programas externos

Ejemplo: firma basada en MD5

Reglas de generación de firmas

Implementación del script público

Ejemplo: firma de API de traducción

Reglas de generación de firmas

Ejemplo de petición

Implementación del script público

Mejores prácticas