amazon web services - que - Usando una clave api en amazon api gateway
postman api gateway (5)
El parámetro x-api-key
se pasa como un parámetro de encabezado HTTP (es decir, no se agrega al cuerpo JSON). La forma en que se pasan los encabezados HTTP depende del cliente HTTP que utilice.
Por ejemplo, si usa el enrollamiento y suponiendo que POST
la carga útil de JSON, una solicitud se vería como (donde reemplaza [api-id]
con el id real y [region]
con la región AWS de su API):
$ curl -X POST -H "x-api-key: theKey" -H "Content-Type: application/json" -d ''{"key":"val"}'' https://[api--id].execute-api.[region].amazonaws.com
He creado una clave api y la he agregado a mis funciones. Luego implementé el api y lo probé, pero aún así obtengo:
"message": "Forbidden"
¿Cómo paso la clave a mi solicitud JSON ya que he estado usando "x-api-key": "theKey"?
Si configura la opción ''Clave de API requerida'' como verdadera, marque a continuación.
tiene que pasar el parámetro de encabezado HTTP ''x-api-key'' a la puerta de enlace API.
La Clave API tuvo que ser creada.
Además, debe verificar un plan de uso para la clave API en la consola de la puerta de enlace API.
Si establece la clave ''API'' requerida en true, debe pasar la clave api como encabezado.
La clave API se pasa como campo de encabezado ''x-api-key''. Incluso después de agregar este campo en el encabezado, este problema puede ocurrir. En ese caso, por favor valide los siguientes puntos.
- ¿Tienes un plan de uso? Si no es necesario crear uno.
- Enlace su API con el Plan de Uso. Para eso agrega una etapa, enlazará tu API
- ¿Tienes API clave? si no es así, debe crear una clave API y habilitarla.
- Agregue el Plan de uso que está vinculado con su API a esta clave de API. Para eso, agrega Plan de Uso.
Tuve que agregar un plan de uso de la API y luego vincular el plan a la etapa de la API.
Parece que esta es la única forma de vincular la clave a la API, no estoy seguro de si se trata de un cambio reciente en AWS.