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.

# Integración de conexión API REST
<a name="rest-api-integration"></a>

Con la integración de la conexión API REST en Amazon Quick, puede realizar acciones con servicios web APIs y REST personalizados. Esta integración solo admite la ejecución de acciones.

## Qué puede hacer
<a name="rest-api-integration-capabilities"></a>

Con la integración de REST API Connection, puede realizar acciones con servicios web APIs y REST personalizados a través del conector de acciones.

**Conector de acciones**  
Realice solicitudes HTTP, recupere datos e interactúe con ellos APIs mediante opciones de autenticación flexibles.

**nota**  
La integración de la conexión a la API REST no admite el acceso a los datos ni la creación de bases de conocimiento. Está diseñado específicamente para la ejecución de tareas y las interacciones de la API con servicios web personalizados.

## Antes de empezar
<a name="rest-api-integration-prerequisites"></a>

Antes de configurar la integración de la API REST, asegúrate de tener lo siguiente:
+ Punto final de la API REST con los permisos de acceso adecuados.
+ Credenciales de autenticación OAuth de API (clave de API u otras).
+ Documentación de API para el servicio web de destino.

## Prepare el punto final y la autenticación de la API
<a name="rest-api-integration-authentication"></a>

Antes de configurar la integración en Amazon Quick, prepare las credenciales de autenticación y punto final de la API REST. La integración de la conexión a la API REST admite varios métodos de autenticación. Elija el método que coincida con los requisitos de su API:

**Autenticación de usuario (OAuth)**  
Recopila la siguiente información de tu proveedor de API:  
+ **URL base: URL** base de la API REST.
+ **ID de cliente: ID** OAuth de cliente de la aplicación.
+ Secreto de **cliente: secreto** del cliente de la OAuth aplicación.
+ **URL del token**: punto final del OAuth token.
+ **URL de autenticación**: punto final OAuth de autorización.
+ **URL de redireccionamiento**: URI de OAuth redireccionamiento.

**Autenticación de servicio (Service-to-service OAuth)**  
Recopila la siguiente información de tu proveedor de API:  
+ **Tipo de autenticación**: las credenciales del cliente OAuth 2.0 otorgan el flujo de service-to-service autenticación.
+ **URL base: URL** base de la API REST.
+ **ID de cliente**: identificador del cliente de OAuth la aplicación para la autenticación del servicio.
+ Secreto de **cliente: secreto** del cliente de la OAuth aplicación para la autenticación del servicio.
+ **URL del token**: punto final del OAuth token para obtener los tokens de acceso.

### Encabezados y parámetros personalizados
<a name="rest-api-custom-headers"></a>

Puede utilizar encabezados y parámetros personalizados para una autenticación flexible y una interacción con la API:
+ Encabezados de autenticación personalizados.
+ Encabezados de versión de API.
+ Especificaciones del tipo de contenido.
+ Parámetros de consulta personalizados.

## Configure la integración de la API REST
<a name="rest-api-integration-setup"></a>

Una vez que hayas preparado el punto de conexión de la API y las credenciales de autenticación, sigue estos pasos para crear la integración de la API REST:

1. En la consola Amazon Quick, selecciona **Integraciones.**

1. Elija **REST API Connection** en las opciones de integración y haga clic en el botón Agregar (más «\$1»).

1. Complete los detalles de la integración:
   + **Nombre: nombre** descriptivo de la integración de la API REST.
   + **Descripción** (opcional): Propósito de la integración.

1. Elige tu tipo de conexión:
   + **Autenticación de usuario**: autenticación OAuth basada en el acceso de usuarios individuales.
   + Autenticación de **servicios: autenticación** basada en claves de API para el acceso al servicio.

1. Complete la configuración de conexión en función del método de autenticación que haya seleccionado (usuario o servicio).

1. Seleccione **Siguiente**.

1. Revise las acciones que están disponibles.

1. Selecciona **Crear y continuar**.

## Acciones de tareas disponibles
<a name="rest-api-integration-actions"></a>

Tras crear la integración de la API de REST, puede revisar las acciones disponibles para interactuar con la API de REST. Las acciones más comunes de la API REST incluyen:
+ Solicitudes HTTP GET para la recuperación de datos.
+ Solicitudes HTTP POST para la creación de datos.
+  PUT/PATCH Solicitudes HTTP de actualización de datos.
+ Solicitudes HTTP DELETE para la eliminación de datos.
+ Interacciones de punto final personalizadas.
+ Procesamiento de datos JSON y XML.
+ Gestión de encabezados y parámetros de consulta.

**nota**  
Las acciones específicas disponibles dependen de los puntos finales de la API REST y de los permisos de autenticación configurados para la integración.

## Opciones de configuración de la API
<a name="rest-api-integration-configuration"></a>

Puede configurar varios aspectos de la integración de la API REST para que se ajusten a sus requisitos específicos.

### Configuración de puntos de conexión
<a name="rest-api-endpoint-configuration"></a>

Configure estos ajustes de punto final:
+ URL base y rutas de punto final.
+ Especificaciones del método HTTP.
+ Manejo del formato de solicitud y respuesta.
+ Gestión de errores y lógica de reintentos.

### Gestión de datos
<a name="rest-api-data-handling"></a>

Configure la forma en que su integración procesa los diferentes formatos de datos:
+ Procesamiento de solicitudes y respuestas en JSON.
+ Transformación de datos XML.
+ Datos de formularios y cargas multiparte.
+ Manejo de datos binarios.

## Gestione las integraciones de la API REST
<a name="rest-api-integration-management"></a>

Después de crear la integración de la API REST, puede administrarla mediante estas opciones:
+ **Editar la integración**: actualiza la configuración de autenticación, la URL base o la configuración de la API.
+ **Integración compartida**: haga que la integración esté disponible para otros usuarios de su organización.
+ **Supervise el uso**: consulte la actividad de integración y las métricas de llamadas a la API.
+ **Revisa las acciones**: consulta la lista completa de acciones de la API de REST disponibles.
+ **Pruebe los puntos finales**: valide la conectividad y la autenticación de la API.
+ **Eliminar la integración**: elimina la integración y revoca la autenticación asociada.

**importante**  
Las integraciones de la API REST dependen de la disponibilidad y la configuración del servicio web de destino. Los cambios en la API o en los requisitos de autenticación pueden afectar a la funcionalidad de la integración.