Vinculación de una clave de firma
Función
Una clave de firma solo tiene efecto después de estar enlazada a una API. Al solicitar el servicio de backend, APIG utiliza la clave de firma para firmar solicitudes criptográficamente. El servicio backend verifica la firma para identificar las fuentes de solicitud.
Esta API se utiliza para vincular una clave de firma a una o más API publicadas.
Se pueden enlazar diferentes claves de firma a una API en entornos diferentes, pero solo se puede enlazar una clave de firma a la API en el mismo entorno.
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/sign-bindings |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
sign_id |
Sí |
String |
ID de clave de firma |
publish_ids |
Sí |
Array of strings |
ID de registro de publicación de API |
Ejemplo de solicitud:
{ "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "publish_ids": [ "374a6d5a-20c7-4ea1-82e1-19fce4556956", "65e6fe53-1ac3-4481-ba36-9f0bc6f22057" ] }
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
- |
Dictionary |
Lista de API enlazadas a la clave de firma |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de vinculación |
api_id |
String |
ID de API |
api_name |
String |
Nombre de la API |
api_remark |
String |
Descripción de la API |
group_name |
String |
Nombre del grupo de API al que pertenece la API |
api_type |
Integer |
Tipo de API |
sign_id |
String |
ID de clave de firma |
sign_name |
String |
Nombre de clave de firma |
sign_key |
String |
Clave de firma |
sign_secret |
String |
Secreto de firma |
env_id |
String |
ID del entorno en el que se ha publicado la API |
env_name |
String |
Nombre del entorno en el que se ha publicado la API |
binding_time |
Timestamp |
Hora en la que la clave de firma está enlazada a la API |
publish_id |
String |
ID del registro de publicación |
Ejemplo de respuesta:
[ { "id": "d8426fb090e442c4a56a35e451bea085", "api_id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b", "api_name": "bbb", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T03:17:26.396039456Z", "publish_id": "23234202f5834ab69113fc1b790b6bed" }, { "id": "97952732e6d7452d99de02db99acce27", "api_id": "d85c502a-f916-47e8-bba0-50537a2d1af2", "api_name": "aaa", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T03:17:26.39803282Z", "publish_id": "6581f68efddc4ff0815e156ec6ecfb52" } ]
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |