Create, view, edit, and delete connections and API destinations - EventBridge

Este tema describe cómo crear, consultar, editar y eliminar conexiones y destinos de API para integrarse rápidamente con otras aplicaciones.

Requisitos previos

Activate EventBridge and grant permissions

Contexto

Los destinos de API permiten invocar las API HTTP o HTTPS de sistemas SaaS de terceros o de sus propios sistemas autogestionados. Este método de integración de bajo código no requiere arquitectura adicional para las llamadas a la API. Con los destinos de API, puede construir y conectarse fácilmente a aplicaciones SaaS y eliminar los silos de datos. Además, varias API pueden compartir una sola conexión, lo que proporciona una autenticación práctica y modular.

La invocación de API en sistemas SaaS de terceros o autogestionados involucra dos componentes de EventBridge: un destino de API y una conexión.

Un destino de API define los metadatos de una API. Al crear una regla de eventos, puede hacer referencia a distintos destinos de API para acceder a diferentes sistemas SaaS de terceros o autogestionados. Varias reglas también pueden hacer referencia al mismo destino de API. Si varias reglas entregan eventos a la misma API de destino, tendría que modificar cada regla individualmente si se necesita cambiar un parámetro. Sin embargo, si define la API de destino como un destino de API, solo necesita modificar la configuración del destino de API. Todas las reglas de eventos que hacen referencia a este destino de API se actualizan automáticamente.

API端点2

Una conexión establece el vínculo entre un servicio externo y el destino de API. Una conexión incluye una configuración de red y una configuración de autenticación. La configuración de red especifica si el servicio externo se conecta al destino de API a través de una red pública o privada. Para la configuración de autenticación, EventBridge admite tres métodos comunes: autenticación básica, OAuth y clave de API.

Autenticación básica: utiliza un nombre de usuario y una contraseña para acceder a un recurso de datos. El nombre de usuario y la contraseña se codifican en Base64, se les añade el prefijo Basic y se envían al servicio de destino. Si el servicio decodifica las credenciales y la autenticación es exitosa, responde a la solicitud de EventBridge. De lo contrario, la solicitud se rechaza.
OAuth: un método de autorización seguro y confiable. OAuth tiene cuatro tipos de concesión: código de autorización, implícito, contraseña y credencial de cliente. En escenarios orientados a eventos, se utiliza comúnmente el tipo de concesión de credencial de cliente. En este modo, debe configurar en EventBridge la información necesaria para obtener una credencial de cliente, incluido el endpoint de autorización, el ID de cliente y el secreto de cliente. EventBridge admite los métodos GET y POST para recuperar la credencial de cliente.
Clave de API: un método de autenticación sencillo. Puede definir un nombre de clave y un valor personalizados para el acceso a la API. EventBridge envía estas credenciales en un encabezado HTTP al servidor para su autenticación.

API端点

Conexiones

Crear una conexión

Al crear un destino de API, lo asocia con una conexión. La conexión define el método de autenticación y la configuración de red para la llamada a la API.

Inicie sesión en la consola de EventBridge. En el panel de navegación izquierdo, elija Integrations > API Destinations.
En la barra de menú superior, seleccione una región y luego haga clic en la pestaña Connection Configuration.

En la pestaña Connection, haga clic en Create. En el panel Create Connection, configure los siguientes parámetros y haga clic en OK.

Parámetro	Descripción	Ejemplo
Name	El nombre de la conexión.	testName
Description	La descripción de la conexión.	test
Authentication	El método de autenticación para la conexión. Valores válidos: Basic OAuth Client Credential API Key	Basic
Username	El nombre de usuario para la autorización. Este parámetro es obligatorio solo cuando Authentication está establecido en Basic.	Admin
Password	La contraseña para la autorización. Este parámetro es obligatorio solo cuando Authentication está establecido en Basic.
Endpoint	La URL del endpoint de autorización para obtener el `access_token`. Este parámetro es obligatorio solo cuando Authentication está establecido en OAuth Client Credential.	https://postman-echo.com/oauth1
HTTP Method	El método de solicitud utilizado para obtener el `access_token`. Este parámetro es obligatorio solo cuando Authentication está establecido en OAuth Client Credential.	POST
Client ID	El ID del cliente que autoriza para obtener el `access_token`. Este parámetro es obligatorio solo cuando Authentication está establecido en OAuth Client Credential.	Admin
Client Secret	El secreto del ID de cliente autorizado. Este parámetro es obligatorio solo cuando Authentication está establecido en OAuth Client Credential.
OAuth HTTP Parameter	Los encabezados de solicitud, cuerpo y parámetros de consulta que se agregan a la solicitud para obtener el `access_token`. Este parámetro es obligatorio solo cuando Authentication está establecido en OAuth Client Credential.	`Parameter:Header key:name Value:eventbridge`
API Key Name	El nombre de la clave para la autorización. Este parámetro es obligatorio solo cuando Authentication está establecido en API Key.	Admin
API Key Value	El valor de la clave autorizada. Este parámetro es obligatorio solo cuando Authentication está establecido en API Key.
Network	El tipo de conexión de red entre el destino de API y la aplicación de terceros. El valor predeterminado es Internet.	Public Network

Otras operaciones

Después de crear una conexión, puede consultarla, editarla y eliminarla desde la consola.

Para consultar detalles: en la columna Actions de la conexión, haga clic en Details para ver su información básica, configuración de autenticación, configuración de red y destinos de API vinculados.
Para editar una conexión: en la columna Actions de la conexión, haga clic en Edit para modificar la descripción de la conexión.
Para eliminar una conexión: en la columna Actions de la conexión, haga clic en Delete. Revise la información en el cuadro de diálogo Show Tooltip y haga clic en OK para eliminar la conexión.

Destinos de API

Crear un destino de API

Inicie sesión en la consola de EventBridge. En el panel de navegación izquierdo, elija Integrations > API Destinations.
En la barra de menú superior, seleccione una región y luego haga clic en la pestaña API Destinations.
En la pestaña API Destination, haga clic en Create. En el panel Create API Destination, configure los siguientes parámetros y haga clic en OK.
1. En la sección Basic Information, establezca Method en Custom y, a continuación, introduzca un nombre y una descripción para el destino de API.
2. En la sección API Configuration, establezca URL en la dirección de API del recurso del servidor al que desea acceder. Establezca HTTP Method en el método de solicitud para acceder a la URL.
3. En la sección Connection, seleccione Create Connection o Select Existing Connection y, a continuación, haga clic en OK.
  - Create Connection: configure el nombre, la descripción, la configuración de autenticación y la configuración de red para la conexión como se describe en Create a connection.
  - Select Existing Connection: seleccione una conexión preconfigurada de la lista desplegable.

Seleccionar un destino de API como objetivo de evento

Inicie sesión en la consola de EventBridge. En el panel de navegación izquierdo, haga clic en Event Buses.
En la barra de menú superior, seleccione una región. En la página Event Buses, haga clic en el nombre del bus de eventos de destino.
En el panel de navegación izquierdo, haga clic en Event Rules y luego en Create Rule.
En el panel Create Rule, complete las siguientes configuraciones y haga clic en Create.
1. Configure la información básica y el patrón de eventos para la regla. Para más información, consulte Create an event rule.
2. En la pestaña Configure Targets, seleccione Triggered by API Operation en la lista desplegable Service Type.
  - Para crear un destino de API personalizado: en la sección Basic Information, seleccione Custom como método de creación. Luego, complete la configuración siguiendo los pasos de la sección Crear un destino de API.
  - Para usar un destino de API existente: en la sección Basic Information, seleccione Use Existing API Destination como método de creación y, a continuación, seleccione un destino de API preconfigurado de la lista desplegable.

Otras operaciones

Después de crear un destino de API, puede consultarlo, editarlo y eliminarlo desde la consola.

Para consultar detalles: en la columna Actions del destino de API, haga clic en Details para ver su información básica, configuración de API y conexión.
Para editar un destino de API: en la columna Actions del destino de API, haga clic en Edit para modificar su descripción y configuración de API.
Para eliminar un destino de API: en la columna Actions del destino de API, haga clic en Delete. Revise la información en el cuadro de diálogo Show Tooltip y haga clic en OK para eliminar el destino de API.