Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Integre Amazon API Gateway con Amazon SQS para gestionar el REST asíncrono APIs
<a name="integrate-amazon-api-gateway-with-amazon-sqs-to-handle-asynchronous-rest-apis"></a>

*Natalia Colantonio Favero y Gustavo Martim, Amazon Web Services*

## Resumen
<a name="integrate-amazon-api-gateway-with-amazon-sqs-to-handle-asynchronous-rest-apis-summary"></a>

Al implementar REST APIs, a veces es necesario exponer una cola de mensajes que las aplicaciones cliente puedan publicar. Por ejemplo, es posible que tenga problemas con la latencia de terceros APIs y que se produzcan retrasos en las respuestas, o puede que desee evitar el tiempo de respuesta de las consultas a la base de datos o escalar el servidor cuando hay un gran número de consultas APIs simultáneas. En estos escenarios, las aplicaciones cliente que publican en la cola solo necesitan saber que la API ha recibido los datos, no lo que ocurre después de recibirlos.

Este patrón crea un punto de conexión de la API de REST mediante [Amazon API Gateway](https://aws.amazon.com/api-gateway/) para enviar un mensaje a [Amazon Simple Queue Service (Amazon SQS)](https://aws.amazon.com/sqs/). Crea una easy-to-implement integración entre los dos servicios que evita el acceso directo a la cola de SQS.

## Requisitos previos y limitaciones
<a name="integrate-amazon-api-gateway-with-amazon-sqs-to-handle-asynchronous-rest-apis-prereqs"></a>
+ [Una cuenta activa AWS](https://portal.aws.amazon.com/billing/signup/iam)

## Arquitectura
<a name="integrate-amazon-api-gateway-with-amazon-sqs-to-handle-asynchronous-rest-apis-architecture"></a>

![Arquitectura para integrar API Gateway con Amazon SQS](http://docs.aws.amazon.com/es_es/prescriptive-guidance/latest/patterns/images/pattern-img/70984dee-e49f-4446-9d52-49ce826c3909/images/737ba0b2-da8f-4478-8c54-0a4835fd69f9.png)


En el siguiente diagrama se muestran estos pasos:

1. Solicite un punto de conexión de la API de REST POST mediante una herramienta como Postman, otra API u otras tecnologías.

1. API Gateway publica un mensaje, que se recibe en el cuerpo de la solicitud, en la cola.

1. Amazon SQS recibe el mensaje y envía una respuesta a API Gateway con un código de éxito o error.

## Tools (Herramientas)
<a name="integrate-amazon-api-gateway-with-amazon-sqs-to-handle-asynchronous-rest-apis-tools"></a>
+ [Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html) le ayuda a crear, publicar, mantener, supervisar y proteger REST, HTTP y WebSocket APIs a cualquier escala.
+ [AWS Identity and Access Management (IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html) le ayuda a administrar de forma segura el acceso a sus AWS recursos al controlar quién está autenticado y autorizado a usarlos.
+ [Amazon Simple Queue Service (Amazon SQS)](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html) ofrece una cola alojada segura, duradera y disponible que le permite integrar y desacoplar sistemas y componentes de software distribuidos.   

## Epics
<a name="integrate-amazon-api-gateway-with-amazon-sqs-to-handle-asynchronous-rest-apis-epics"></a>

### Creación de una cola de SQS
<a name="create-an-sqs-queue"></a>


| Tarea | Descripción | Habilidades requeridas | 
| --- | --- | --- | 
| Creación de una cola. | Para crear una cola de SQS que reciba los mensajes de la API de REST:1. Inicie sesión en su [Cuenta de AWS](https://portal.aws.amazon.com/billing/signup/iam).<br />2. Abra la consola Amazon SQS en. [https://console.aws.amazon.com/sqs/](https://console.aws.amazon.com/sqs/)<br />3. Elige **Crear cola**.<br />4. En la página **Crear cola**, elija la correcta en la lista desplegable Región de AWS de **regiones**.<br />5. En **Tipo**, mantenga los ajustes predeterminados (**Estándar**).<br />6. Escriba un **Nombre** para la cola.<br />7. Mantenga los valores predeterminados para el resto de ajustes.<br />8. Elige **Crear cola**. | Desarrollador de aplicaciones | 

### Cómo proporcionar acceso a Amazon SQS
<a name="provide-access-to-sqs"></a>


| Tarea | Descripción | Habilidades requeridas | 
| --- | --- | --- | 
| Crear un rol de IAM. | Este rol de IAM proporciona a los recursos de API Gateway acceso completo a Amazon SQS.1. Abra la consola de IAM en [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/).<br />2. En el panel de navegación, seleccione **Roles**, **Crear rol**.<br />3. En **Tipo de entidad de confianza**, elija **Servicio de AWS**.<br />4. En **Caso de uso**, elija **API Gateway** en la lista desplegable y, a continuación, elija **Siguiente**, **Siguiente**.<br />5. **En el **nombre del rol**, introduzca **AWSGatewayRoleForSQS** y una descripción opcional y, a continuación, elija Crear rol.**<br />6. En el panel **Funciones**, busque **AWSGatewayRoleForSQS** y seleccione su casilla de verificación.<br />7. En la sección **Políticas de permisos**, elija **Agregar permisos**, **Adjuntar políticas**.<br />8. Busca **Amazon SQSFull Access** y selecciónalo.<br />9. Elija **Añadir permisos**.<br />10. En la sección **Resumen** de **AWSGatewayRoleForSQS**, copie el número de recurso de Amazon (ARN). Usará este ID en un paso posterior. | Desarrollador de aplicaciones, administrador de AWS | 

### Crear una API de REST
<a name="create-a-rest-api"></a>


| Tarea | Descripción | Habilidades requeridas | 
| --- | --- | --- | 
| Crear una API de REST. | Esta es la API de REST a la que se envían las solicitudes HTTP.1. Abra la consola de API Gateway en [https://console.aws.amazon.com/apigateway/](https://console.aws.amazon.com/apigateway/).<br />2. En el cuadro **API de REST**, elija **Crear**.<br />3. En **Nombre de API**, ingrese un nombre y una descripción opcional para la API, conserve todas las demás configuraciones predeterminadas y, a continuación, seleccione **Crear API**. | Desarrollador de aplicaciones | 
| Conectar API Gateway a Amazon SQS. | Este paso permite que el mensaje fluya desde el cuerpo de la solicitud HTTP hasta Amazon SQS.1. En la [consola de API Gateway](https://console.aws.amazon.com/apigateway/), elija la API que ha creado.<br />2. En la página **Recursos**, en la sección **Métodos**, elija **Crear método**.<br />3. En **Tipo de método**, elija **POST**. <br />4. En **Tipo de integración**, elija **Servicio de AWS**.<br />5. En **Región de AWS**, elija la región en la que creó la cola de SQS.<br />6. En **Servicio de AWS**, elija **Simple Queue Service (SQS)**.<br />7. En Método HTTP, elija **POST**.<br />8. En **Tipo de acción**, elija **Usar sustitución de ruta**.<br />9. En **Sustitución de ruta**, ingrese **<ID de la cuenta de AWS>/<nombre de la cola de SQS>**.<br />10. En **Rol de ejecución**, pegue el ARN del rol que creó anteriormente.<br />11. Elija **Crear método**. | Desarrollador de aplicaciones | 

### Prueba de la API de REST
<a name="test-the-rest-api"></a>


| Tarea | Descripción | Habilidades requeridas | 
| --- | --- | --- | 
| Probar la API de REST. | Ejecute una prueba para comprobar si falta alguna configuración:1. En la [consola de API Gateway](https://console.aws.amazon.com/apigateway/), elija la API de REST que ha creado.<br />2. En el panel **Recursos**, elija el método **POST**.<br />3. Elija la pestaña **Prueba**. (Use la flecha derecha si no se muestra la pestaña).<br />4. En **Cuerpo de la solicitud**, pegue el siguiente código JSON:<pre>{<br />     "message": "lorem ipsum"<br />}</pre><br />5. Seleccione **Probar**<br />Recibirá un error similar al siguiente:<pre><UnknownOperationException/></pre> | Desarrollador de aplicaciones | 
| Cambiar la integración de la API para reenviar la solicitud correctamente a Amazon SQS. | Complete la configuración para corregir el error de integración:1. En la [consola de API Gateway](https://console.aws.amazon.com/apigateway/), elija la API que creó y, a continuación, elija **POST**.<br />2. En la sección **Ejecución de método** se muestra la asignación visual entre API Gateway y Amazon SQS. En esta sección, elija **Solicitud de integración** y, a continuación, **Editar**.<br />3. Expanda la sección **Encabezados HTTP** y, a continuación, elija el parámetro **Agregar encabezado de solicitud**.En **Nombre**, especifique **Content-Type**.En **Mapped from**, introduzca **«application/» x-www-form-urlencoded**. Asegúrese de incluir las comillas simples.Seleccione la casilla de verificación **Almacenamiento en caché**.<br />4. Expanda la sección **Plantillas de mapeo**.Elija **Add mapping template (Añadir plantilla de asignación)**.En **Tipo de contenido**, escriba **application/json**.En **Cuerpo de la plantilla**, pegue este código:<pre>Action=SendMessage&MessageBody=$input.body</pre>Seleccione **Save**. | Desarrollador de aplicaciones | 
| Probar y validar el mensaje en Amazon SQS. | Ejecute una prueba para confirmar que la prueba se haya completado correctamente:1. En la [consola de API Gateway](https://console.aws.amazon.com/apigateway/), elija la API de REST que ha creado.<br />2. En el panel **Recursos**, elija el método **POST**.<br />3. Elija la pestaña **Prueba**. (Use la flecha derecha si no se muestra la pestaña).<br />4. En **Cuerpo de la solicitud**, pegue el siguiente código JSON:<pre>{<br />     "message": "lorem ipsum"<br />}</pre><br />5. Seleccione **Probar**<br />6. Abra la [consola de Amazon SQS](https://console.aws.amazon.com/sqs/).<br />7. En el panel de navegación, elija **Colas** y luego elija su cola.<br />8. Seleccione **Enviar y recibir mensajes**.<br />9. Seleccione **Sondeo de mensajes**.<br />10. Elija **Mensaje**. Debería aparecer lo siguiente:<pre>Body { "message": "lorem ipsum" }</pre> | Desarrollador de aplicaciones | 
| Probar API Gateway con un carácter especial. | Ejecute una prueba que incluya caracteres especiales (como &) que no sean aceptables en un mensaje:1. En la [consola de API Gateway](https://console.aws.amazon.com/apigateway/), elija su API.<br />2. Repita la prueba del paso anterior con el siguiente código JSON:<pre>{<br />     "message": "lorem ipsum &"<br />}</pre><br />3. Seleccione **Probar**<br />Recibirá un error como el siguiente:<pre>{<br />  "Error": {<br />    "Code": "AccessDenied",<br />    "Message": "Access to the resource https://sqs.us-east-2.amazonaws.com/976166761794/Apg2 is denied.",<br />    "Type": "Sender"<br />  },<br />  "RequestId": "e83c9c67-bcf6-5e9a-91e9-c737094b17ab"<br />}</pre><br />Esto se debe a que los caracteres especiales no se admiten de forma predeterminada en el cuerpo del mensaje. En el siguiente paso, configurará API Gateway para que admita caracteres especiales. Para obtener más información sobre las conversiones de tipos de contenido, consulte la [documentación de API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-workflow.html). | Desarrollador de aplicaciones | 
| Cambiar la configuración de la API para que admita caracteres especiales. | Ajuste la configuración para que acepte caracteres especiales en el mensaje:1. En la [consola de API Gateway](https://console.aws.amazon.com/apigateway), elija la API que creó y, a continuación, elija **POST**.<br />2. Elija **Solicitud de integración** y, a continuación, **Editar**.<br />3. Cambie **Tratamiento de contenido** a **Convertir en texto**.<br />4. En la sección **Plantillas de mapeo**:En **Tipo de contenido**, escriba **application/json**.En **Cuerpo de la plantilla**, especifique:<pre>Action=SendMessage&MessageBody=$util.urlEncode($input.body)</pre>Seleccione **Save**.<br />5. Elija la pestaña **Prueba**.<br />6. En **Cuerpo de la solicitud**, ingrese el código JSON anterior:<pre>{<br />     " message": "lorem ipsum &" }</pre><br />7. Seleccione **Probar**<br />8. Abra la [consola de Amazon SQS](https://console.aws.amazon.com/sqs/).<br />9. Seleccione su cola y, a continuación, elija **Enviar y recibir mensajes**, **Sondear si hay mensajes** y **Mensaje** como antes.<br />El nuevo mensaje debe incluir el carácter especial. | Desarrollador de aplicaciones | 

### Implementación de la API de REST
<a name="deploy-the-rest-api"></a>


| Tarea | Descripción | Habilidades requeridas | 
| --- | --- | --- | 
| Implementar la API. |  <br />Para implementar la API de REST:1. Abra la [consola de API Gateway](https://console.aws.amazon.com/apigateway/).<br />2. Elija la API.<br />3. Elija **Implementar API**. Para obtener más información sobre este paso, consulte la [documentación de API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api-with-console.html). | Desarrollador de aplicaciones | 
| Probar con una herramienta externa. | Ejecute una prueba con una herramienta externa para confirmar que el mensaje se ha recibido correctamente:1. Abra una herramienta como Postman, Insomnia o cURL.<br />2. Ejecute su API.<br />3. Abra la [consola de Amazon SQS](https://console.aws.amazon.com/sqs/).<br />4. Seleccione su cola.<br />5. Cargue los mensajes para ver el mensaje nuevo. | Desarrollador de aplicaciones | 

### Eliminación
<a name="clean-up"></a>


| Tarea | Descripción | Habilidades requeridas | 
| --- | --- | --- | 
| Eliminar la API. | En la [consola de API Gateway](https://console.aws.amazon.com/apigateway/), elija la API que creó y, a continuación, elija **Eliminar**. | Desarrollador de aplicaciones | 
| Eliminación del rol de IAM. | **En la [consola de IAM](https://console.aws.amazon.com/iam/), en el panel **Funciones**, seleccione **AWSGatewayRoleForSQS** y, a continuación, elija Eliminar.** | Desarrollador de aplicaciones | 
| Eliminar la cola de SQS. | En la [consola de Amazon SQS](https://console.aws.amazon.com/sqs/), en el panel **Colas**, elija la cola de SQS que ha creado y, a continuación, elija **Eliminar**. | Desarrollador de aplicaciones | 

## Recursos relacionados
<a name="integrate-amazon-api-gateway-with-amazon-sqs-to-handle-asynchronous-rest-apis-resources"></a>
+ [SQS- SendMessage](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html#SQS-SendMessage) (documentación de API Gateway)
+ [Conversiones de tipo de contenido en API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-workflow.html) (documentación de API Gateway)
+ [Variables $util](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-template-reference) (documentación de API Gateway)
+ [¿Cómo puedo integrar una API REST de API Gateway con Amazon SQS y resolver los errores más comunes?](https://repost.aws/knowledge-center/api-gateway-rest-api-sqs-errors) (Artículo de AWS Re:POST)