新建连接器

操作场景

在AstroCanvas中，通过新建HTTP连接器，可引入第三方的API作为组件的数据来源。

新建连接器

1. 参考登录AstroCanvas界面中操作，登录AstroCanvas界面。
2. 在主菜单中，选择“数据中心”。
3. 在左侧导航栏中，选择“连接器”。
4. 在连接器管理页面，单击“新建连接器”。
5. 设置基本信息。
   图2 基本信息（无身份验证）
   
   图3 基本信息（AK/SK）
   
   图4 基本信息（API Key）
   
   图5 API鉴权
   
   • 连接器名称：输入新建连接器的名称，长度为1~32个字符，可包括中文、字母、数字及下划线。
   • 类型：选择连接器类型，便于管理连接器。单击“新建类型”，可自定义连接器类型。
   • 上传图标：单击，可设置连接器显示的图标。
   • 描述：新建连接器的描述信息，可按需进行设置。
   • 请求协议：设置连接器请求协议。
   • 域名：请求的Host地址，不需要带上“http://”或“https://”协议头，同时也不需要“/”结尾。
   • 域名参数：配置域名参数，包含字段名称、默认值和字段描述。
     图6 配置域名参数
     
     

     连接器配置中，当域名中配置“{字段名}”参数时，才会显示该参数。

   • 接口鉴权方式：设置接口鉴权方式，支持API鉴权、AK/SK、API Key和无身份验证。
     • API鉴权：填写API鉴权信息后，可在连接器中选择其响应参数，作为连接器请求参数的值。
     • 无身份验证：不需要任何验证信息，直接调用接口，通常用于访问一些公开的接口。
     • AK/SK：通过访问密钥进行接口鉴权。访问密钥即AK/SK（Access Key ID/Secret Access Key），是您访问系统的身份凭证，系统通过AK识别访问用户的身份，通过SK进行签名验证，通过加密签名验证可以确保请求的机密性、完整性和请求者身份的正确性。
     • API Key：使用API密钥进行授权，鉴权信息可以附加在Query或Header中。
   • 鉴权信息：“接口鉴权方式”设置为“API鉴权”时，才会显示该参数。单击“新建鉴权信息”，设置鉴权信息。
     图7 新建鉴权信息
     
     • API鉴权名称：设置API鉴权名称，长度为1~32个字符，可包括中文、字母、数字及下划线。
     • API鉴权描述：设置API鉴权描述信息。
     • API鉴权地址：设置API鉴权地址，通过输入字符“{xx}”可在请求参数Path列表中使用变量“xx”。
     • 请求方式：设置接口请求方式，支持GET和POST。
     • 请求参数：设置接口请求参数。设置成功后，可单击“测试API接口”，可进行接口调试。
     • 返回参数：设置接口返回参数，此处的响应参数，可作为连接器请求参数的值。
   • 参数位置：把鉴权信息附加在Query或Header中，请根据实际需求进行配置。“接口鉴权方式”设置为“API Key”时，才会显示该参数。
   • 参数名称：API Key的名称，请根据实际需求进行配置。“接口鉴权方式”设置为“API Key”时，才会显示该参数。

6. 设置执行动作。
   图8 添加动作
   
   图9 将鉴权信息中返回的参数赋值给连接器中Header参数
   
   • 动作名称：设置新增动作的名称，长度为1~32个字符，可包括中文、字母、数字及下划线。
   • 动作描述：新增动作的描述信息。
   • 请求地址：设置请求地址，通过输入字符“{xx}”可在请求参数Path列表中使用变量“xx”。
   • 请求方法：请根据接口类型，选择请求方法。
   • 请求参数
     • Query：请求的参数，通常指的是URL中“?”后的附加参数。
     • Header：Header中需要的参数，支持“字符串”和“表达式”两种。“字段类型”设置为“表达式”时，单击“默认值”，可将5中鉴权信息中返回的参数赋值给连接器的请求参数。
     • Body：当请求类型为POST时，还需要设置Body，可以使用默认值也可以根据实际需求进行填写。
     • Path：URL中配置的带大括号的变量。例如{pathParam} ，其中pathParam会作为变量名。
   • 返回参数：设置返回参数。在Body中，可以贴一段预期结果的json，使用时可以解析出字段格式。

7. 认证信息设置完成后，单击“测试”，测试接口是否有效。
8. 测试成功后，单击“保存”，完成连接器的创建。