Creación de una clave de firma
Función
Es una buena práctica proporcionar un mecanismo de protección para que las API garanticen la seguridad del acceso. Por ejemplo, autenticar fuentes de solicitud de API y denegar el acceso de fuentes no autorizadas.
Una clave de firma es un mecanismo de protección en el caso.
Cree una clave de firma y vincúlela a una API. Al solicitar la API, APIG utiliza la clave de firma para cifrar datos de parámetros de solicitud y generar una firma. El servicio de backend de la API verifica las solicitudes mediante la firma. Se denegarán las solicitudes no autorizadas para proteger la API contra ataques de fuentes desconocidas.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
POST |
/v1.0/apigw/signs |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
name |
Sí |
String |
Nombre de clave de firma El nombre de una clave de firma consta de 3 a 64 caracteres, comenzando por una letra. Solo se permiten letras, dígitos y guiones bajos (_). |
sign_key |
No |
String |
Clave de firma Una clave de firma consta de 8 a 32 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_). Una clave es generada automáticamente por el backend si no se especifica ninguna clave. |
sign_secret |
No |
String |
Secreto de firma Un secreto de firma consta de 16 a 64 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos y caracteres especiales (-_!@#$%). El backend genera automáticamente un valor si no se especifica ningún valor. |
Ejemplo de solicitud:
{ "name": "signature01", "sign_key": "abcd_123", "sign_secret": "******" }
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de clave de firma |
name |
String |
Nombre de clave de firma |
sign_key |
String |
Clave de firma |
sign_secret |
String |
Secreto de firma |
create_time |
Timestamp |
Hora en que se crea la clave de firma |
update_time |
Timestamp |
Hora en la que se actualizó por última vez la clave de firma |
Ejemplo de respuesta:
{ "name": "signature01", "sign_key": "abcd_123", "sign_secret": "******", "id": "3a793b65a9034bdfae08924f149bfb4a", "create_time": "2018-02-06T12:17:36.039953112Z", "update_time": "2018-02-06T12:17:36.039954198Z" }
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Server Internal Error |