Todos os produtos
Search

Este produto

    EventBridge:Gerencie API destinations

    Central de documentação

    EventBridge:Gerencie API destinations

    Última atualização: Jun 28, 2026

    Este tópico descreve como criar, visualizar, editar e excluir conexões e API destinations para integrar rapidamente outros aplicativos.

    Pré-requisitos

    Ativar o EventBridge e conceder permissões

    Informações de fundo

    Use API destinations para chamar APIs HTTP ou HTTPS de sistemas SaaS de terceiros ou de seus próprios sistemas autogerenciados. Esse método de integração low-code não exige arquitetura adicional para chamadas de API. Com as API destinations, é possível construir e conectar facilmente aplicativos SaaS, eliminando silos de dados. Além disso, várias APIs podem compartilhar uma única conexão, oferecendo autenticação prática e plugável.

    A chamada de APIs em sistemas SaaS de terceiros ou autogerenciados envolve dois componentes do EventBridge: uma API destination e uma conexão.

    Uma API destination define os metadados de uma API. Ao criar uma regra de evento, referencie diferentes API destinations para acessar distintos sistemas SaaS de terceiros ou autogerenciados. Várias regras também podem referenciar a mesma API destination. Se múltiplas regras entregarem eventos à mesma API de destino e um parâmetro precisar ser alterado, será necessário modificar cada regra individualmente. No entanto, ao definir a API de destino como uma API destination, basta modificar a configuração dessa API destination. Todas as regras de evento que a referenciam são atualizadas automaticamente.

    API端点2

    Uma conexão estabelece o vínculo entre um serviço externo e a API destination. Ela inclui uma configuração de rede e uma configuração de autenticação. A configuração de rede especifica se o serviço externo se conecta à API destination por meio de uma rede pública ou privada. Para a configuração de autenticação, o EventBridge oferece suporte a três métodos comuns: autenticação básica, OAuth e chave de API.

    • Autenticação básica: utiliza nome de usuário e senha para acessar um recurso de dados. O nome de usuário e a senha são codificados em Base64, prefixados com Basic e enviados ao serviço de destino. Se o serviço decodificar as credenciais e a autenticação for bem-sucedida, ele responderá à solicitação do EventBridge. Caso contrário, a solicitação será rejeitada.

    • OAuth: método de autorização seguro e confiável. O OAuth possui quatro tipos de concessão: código de autorização, implícito, senha e credencial de cliente. Em cenários orientados a eventos, o tipo de concessão de credencial de cliente é comumente utilizado. Nesse modo, configure no EventBridge as informações necessárias para obter uma credencial de cliente, incluindo o endpoint de autorização, ID do cliente e segredo do cliente. O EventBridge suporta os métodos GET e POST para recuperar a credencial de cliente.

    • Chave de API: método de autenticação simples. Defina um nome e um valor de chave personalizados para acesso à API. O EventBridge envia essas credenciais em um cabeçalho HTTP ao servidor para autenticação.

    API端点

    Conexões

    Crie uma conexão

    Ao criar uma API destination, associe-a a uma conexão. A conexão define o método de autenticação e as configurações de rede para a chamada de API.

    1. Faça login no console do EventBridge. No painel de navegação à esquerda, escolha Integrations > API Destinations.

    2. Na barra de menus superior, selecione uma região e clique em na aba Connection Configuration.

    3. Na aba Connection, clique em Create. No painel Create Connection, defina os seguintes parâmetros e clique em OK.

      Parâmetro

      Descrição

      Exemplo

      Name

      Nome da conexão.

      testName

      Description

      Descrição da conexão.

      test

      Authentication

      Método de autenticação da conexão. Valores válidos:

      • Basic

      • OAuth Client Credential

      • API Key

      Basic

      Username

      Nome de usuário para autorização. Este parâmetro é obrigatório apenas quando Authentication estiver definido como Basic.

      Admin

      Password

      Senha para autorização. Este parâmetro é obrigatório apenas quando Authentication estiver definido como Basic.

      Endpoint

      URL do endpoint de autorização para obtenção do access_token. Este parâmetro é obrigatório apenas quando Authentication estiver definido como OAuth Client Credential.

      https://postman-echo.com/oauth1

      HTTP Method

      Método de solicitação usado para obter o access_token. Este parâmetro é obrigatório apenas quando Authentication estiver definido como OAuth Client Credential.

      POST

      Client ID

      ID do cliente autorizado a obter o access_token. Este parâmetro é obrigatório apenas quando Authentication estiver definido como OAuth Client Credential.

      Admin

      Client Secret

      Segredo do ID de cliente autorizado. Este parâmetro é obrigatório apenas quando Authentication estiver definido como OAuth Client Credential.

      OAuth HTTP Parameter

      Cabeçalhos de solicitação, corpo e parâmetros de consulta a serem adicionados à solicitação para obter o access_token. Este parâmetro é obrigatório apenas quando Authentication estiver definido como OAuth Client Credential.

      		 
      Parameter:Header
key:name
Value:eventbridge

      API Key Name

      Nome da chave para autorização. Este parâmetro é obrigatório apenas quando Authentication estiver definido como API Key.

      Admin

      API Key Value

      Valor da chave autorizada. Este parâmetro é obrigatório apenas quando Authentication estiver definido como API Key.

      Network

      Tipo de conexão de rede entre a API destination e o aplicativo de terceiros. O valor padrão é Internet.

      Public Network

    Outras operações

    Após criar uma conexão, visualize, edite ou exclua-a no console.

    • Visualize detalhes: na coluna Actions da conexão, clique em Details para ver as informações básicas, configuração de autenticação, configuração de rede e API destinations vinculadas.

    • Edite uma conexão: na coluna Actions da conexão, clique em Edit para modifique a descrição da conexão.

    • Exclua uma conexão: na coluna Actions da conexão, clique em Delete. Revise as informações na caixa de diálogo Show Tooltip e clique em OK para excluir a conexão.

    API destinations

    Crie uma API destination

    1. Faça login no console do EventBridge. No painel de navegação à esquerda, escolha Integrations > API Destinations.

    2. Na barra de menus superior, selecione uma região e clique em na aba API Destinations.

    3. Na aba API Destination, clique em Create. No painel Create API Destination, defina os seguintes parâmetros e clique em OK.

      1. Na seção Basic Information, defina Method como Custom e insira um nome e uma descrição para a API destination.

      2. Na seção API Configuration, defina URL como o endereço da API do recurso de servidor que deseja acessar. Defina HTTP Method como o método de solicitação para acessar a URL.

      3. Na seção Connection, selecione Create Connection ou Select Existing Connection e clique em OK.

        • Create Connection: configure o nome, a descrição, a configuração de autenticação e a configuração de rede da conexão conforme descrito em Criar uma conexão.

        • Select Existing Connection: selecione uma conexão pré-configurada na lista suspensa.

    Selecione uma API destination como destino de evento

    1. Faça login no console do EventBridge. No painel de navegação à esquerda, clique em Event Buses.

    2. Na barra de menus superior, selecione uma região. Na página Event Buses, clique em no nome do barramento de eventos de destino.

    3. No painel de navegação à esquerda, clique em Event Rules e em Create Rule.

    4. No painel Create Rule, conclua as seguintes configurações e clique em Create.

      1. Configure as informações básicas e o padrão de evento da regra. Para mais informações, consulte Criar uma regra de evento.

      2. Na aba Configure Targets, selecione Triggered by API Operation na lista suspensa Service Type.

        • Crie uma API destination personalizada: na seção Basic Information, selecione Custom como método de criação. Em seguida, conclua a configuração seguindo as etapas da seção Criar uma API destination.

        • Usar uma API destination existente: na seção Basic Information, selecione Use Existing API Destination como método de criação e escolha uma API destination pré-configurada na lista suspensa.

    Outras operações

    Após criar uma API destination, visualize, edite ou exclua-a no console.

    • Visualize detalhes: na coluna Actions da API destination, clique em Details para ver as informações básicas, configuração da API e conexão.

    • Edite uma API destination: na coluna Actions da API destination, clique em Edit para modifique sua descrição e configuração da API.

    • Exclua uma API destination: na coluna Actions da API destination, clique em Delete. Revise as informações na caixa de diálogo Show Tooltip e clique em OK para excluir a API destination.