本文介绍如何创建、查看、编辑、删除连接配置和API端点，帮助您快速集成其他应用。

前提条件

开通事件总线EventBridge并授权

背景信息

API端点（API Destinations）可以帮助您调用第三方SaaS系统或自建系统的HTTP接口，提供低代码的接入方式，无需更多额外架构即可完成接口调用。借助API端点，您可以轻松构建和对接SaaS应用，打通数据孤岛。同时多个API可共用一套连接配置（Connection），提供便捷、可插拔的鉴权能力。

第三方SaaS系统或自建系统等服务中的API包含了API端点和Connection两部分信息。

API端点定义了API的元数据，您在创建事件规则时可以引用不同的API端点以访问不同的第三方SaaS系统或自建系统，不同规则也可以引用同一个API端点。多个规则向同一个目标服务API进行事件投递时，在没有API端点之前，一旦需要修改某个参数，需要修改所有的规则，但如果将目标服务的API定义成API端点，那么只需要修改API端点的配置，则所有引用这个API端点的规则，将同步自动更新。

API端点2
Connection主要用于实现外部服务与当前API端点的连通性。Connection中包含两部分内容：首先是网络配置，即外部服务与当前API端点之间是通过公网还是私网进行连接。其次，Connection中还包含了鉴权配置信息。事件总线EventBridge选取了目前最常用的三种鉴权方式：Basic Auth、OAuth和API Key。
  • Basic Auth（基本身份验证）：使用时用户名和密码需要经过验证才能访问数据资源。用户名和密码会被base64编码并加上Basic空格前缀，一起发送到目标服务。目标服务端进行解码并认证通过后，会响应事件总线EventBridge的请求，如果认证失败，则直接打回。
  • OAuth（开放授权）：一种更加安全可靠的授权认证方式。OAuth有四种授权方式，分别是授权码、隐藏式、密码式和客户端凭证。在事件驱动场景中，常用到的是客户端凭证授权方式。在这种模式下，您需要在事件总线EventBridge配置获取客户端凭证所需要的一些信息，包括OAuthService地址、客户端ID、客户端密码等，事件总线EventBridge支持GET/POST两种方式，去获取客户端凭证。
  • API Key：一种比较简单的认证方式。用户可以自定义API访问的KeyName和KeyValue。事件总线EventBridge会将其通过HttpHeader的方式，传输到服务端进行认证。
API端点

连接配置（Connection）

创建Connection

创建API端点时，您可以为该端点指定连接，用于定义API端点的授权类型和参数。

  1. 登录事件总线EventBridge控制台，在左侧导航栏，选择集成中心 > API端点。
  2. 在顶部菜单栏，选择地域，然后单击连接配置页签。
  3. 在连接配置页签，单击创建，然后在创建连接配置面板，设置以下参数，完成后单击确定。
    参数描述示例值
    连接名称设置Connection的名称。testName
    连接描述设置Connection的描述。test
    鉴权配置设置Connection的鉴权方式。取值如下：
    • Basic
    • OAuth客户端凭据
    • API Key
    		Basic
    用户名用于授权的用户名。仅当鉴权配置设置为Basic时需要设置此参数。Admin
    密码用于授权的密码。仅当鉴权配置设置为Basic时需要设置此参数。******
    授权接入点设置URL接入点，以获取服务端访问API时需要的access_token。仅当鉴权配置设置为OAuth 客户端凭据时需要设置此参数。https://postman-echo.com/oauth1
    HTTP Method获取access_token时的请求类型。仅当鉴权配置设置为OAuth 客户端凭据时需要设置此参数。POST
    Client ID您授权的允许获取access_token的ID。仅当鉴权配置设置为OAuth 客户端凭据时需要设置此参数。Admin
    ClientSecret您授权的ID的密码。仅当鉴权配置设置为OAuth 客户端凭据时需要设置此参数。******
    OAuth Http 调用参数设置请求获取access_token时需要添加的请求头、请求体和请求参数。仅当鉴权配置设置为OAuth 客户端凭据时需要设置此参数。
    Parameter:Header
key:name
Value:eventbridge
    ApiKeyName用于授权的用户名。仅当鉴权配置设置为API Key时需要设置此参数。Admin
    ApiKeyValue授权的账号的密码。仅当鉴权配置设置为API Key时需要设置此参数。******
    网络选择选择API端点与第三方应用之间的网络连接。默认选择公网。公网

其他操作

Connection创建完成后，您可以在控制台上执行查看、编辑、删除操作。

其他操作
  • 查看详情：在已创建的连接配置右侧操作列单击详情查看基础信息、鉴权配置、网络配置及已绑定的API端点。
  • 编辑连接配置：在已创建的连接配置右侧操作列单击编辑修改连接描述。
  • 删除连接配置：在已创建的连接配置右侧操作列单击删除，然后阅读提示对话框内的信息，单击确定，即可删除此连接配置。

API端点

创建API端点

  1. 登录事件总线EventBridge控制台，在左侧导航栏，选择集成中心 > API端点。
  2. 在顶部菜单栏，选择地域，然后单击API端点页签。
  3. 在API端点页签，单击创建，然后在创建API端点面板，设置以下参数，完成后单击确定。
    1. 在基础信息区域，将创建方式设置为自定义创建，然后设置API目标的名称和描述。
    2. 在API配置区域，设置URL为需要访问的服务端资源的API地址，设置HTTP Method为获取URL的访问方式。
    3. 在连接配置区域，选择新建配置或选择已有，单击确定。
      • 新建配置：参照上文创建Connection中的内容设置连接配置的名称、描述、鉴权配置及网络。
      • 选择已有：在下拉框中选择提前设置好的连接配置。

选择API端点为事件目标

  1. 登录事件总线EventBridge控制台，在左侧导航栏，单击事件总线。
  2. 在顶部菜单栏，选择地域，在事件总线页面，单击目标总线名称。
  3. 在左侧导航栏，单击事件规则，然后单击创建规则。
  4. 在创建规则面板，完成以下配置，然后单击创建。
    1. 设置规则的基本信息与事件模式。详细步骤，请参见创建规则。
    2. 在配置事件目标页签，选择服务类型为API触发。
      • 自定义创建API端点：在基础信息区域，选择创建方式为自定义创建，然后参考上文创建API端点中的步骤完成其他配置。
      • 使用已有API端点：在基础信息区域，选择创建方式为使用已有，在下拉框中选择提前创建好的API端点。

其他操作

API端点创建完成后，您可以在控制台上执行查看、编辑、删除操作。

其他操作
  • 查看详情：在已创建的API端点右侧操作列单击详情查看基础信息、API配置及已连接配置。
  • 编辑API端点：在已创建的API端点右侧操作列单击编辑修改API端点的描述和API配置。
  • 删除API端点：在已创建的API端点右侧操作列单击删除，然后阅读提示对话框内的信息，单击确定，即可删除此端点。