跳到主要内容

服务注册

专业版及以上专享

1. 功能介绍

服务注册是使用服务回调功能的前置步骤,即将需要使用到的第三方服务的接口注册到宜搭平台上来,主要的功能在于设置接口的出入参信息、验权加密信息、权限控制、接口描述信息等,以便在使用时可以快速引用。


目前,宜搭平台提供的服务注册主要包括以下两种类型:

  • HTTP:面向普通企业用户(包括阿里内部生态公司企业用户
  • GATEWAY:仅面向阿里内部生态公司企业用户

特别说明:该功能入口仅面向企业的主管理员、子管理员以及应用管理员开放,如需要使用到该功能,请向所属企业的管理员申请获取使用授权。授权入口:平台管理 >>平台权限管理。更多详细操作,请参考平台权限管理


授权操作如下:

宜搭首页

平台权限管理

2. 基本使用

服务注册操作入口:平台管理(小螺丝图标)>> 服务注册

宜搭首页

整个面板的功能区域包括如下 5 个部分:

(1)服务注册:左侧边栏切换到该栏目,可以展示如下的服务注册的功能页面。

(2)新增服务:点击该按钮,可以新增一条新的服务注册信息。

(3)搜索服务名称:根据根据服务名称进行模糊搜索,搜索结果进行分页展示。

(4)修改基本信息:点击该条目后,会弹出该服务注册的详情信息,可以针对既有的服务注册的信息进行修改。

(5)删除:点击该条目后,可以删除该项服务注册信息。

服务注册页面

3. 服务注册类型

3.1 HTTP 类型的服务注册

在注册注册的页面,点击 新增服务 按钮,类型选择为 HTTP, 即可创建HTTP类型的服务注册。HTTP类型的服务注册,包含:名称、使用人员(平台所有人 or 指定人员)、Url完整地址、签名验证(目前仅支持MD5、SHA256签名验证)、参数列表、服务描述。


下面针对创建一个完整的 HTTP 类型的服务注册所需信息进行详细介绍:

  1. 类型:选择类型:HTTP。
  2. 名称创建服务时,可以根据自己需要来填写。名称建议带有业务含义,以便在服务列表页面可以进行检索查询。
  3. 管理员:可以查看服务注册里面的接口详情并且可以修改相关的配置,包括修改增加其他管理员等。
  4. 平台公共服务:该勾选该栏目时,表示该服务注册可以为平台所有应用管理员使用。
  5. 使用人员:相当于该服务注册授权给哪些人去使用,被授权的人员可以在表单里面配置服务注册的时候可以选择到该服务注册。
  6. url 完整地址需要访问的http接口对应的完整地址,例如:https://www.aliwork.com/test
  7. MD5 签名验证MD5(32位大写)签名验证,当选择加密时需要额外输入 加密密钥(自定义),宜搭在发起请求时会使用该密钥和所有入参一起进行加密,加密的字符串会以默认参数:__signature(流程里的自动节点使用的参数名是: sign ) 传递给目标服务。目标服务验证签名时需要将所有参数值进行去重(宜搭内部使用TreeSet处理,调用时需要保证服务端参数名不重复)升序排序,每个参数值之间使用$分隔,并在末尾拼接密钥后进行 MD5 加密,例如:当参数值为123,密钥为test时的加密串为:123$test时的加密串为:123$test。
  8. SHA256签名验证当选择开启加密时,需要额外输入 加密密钥(自定义),宜搭在发起请求时会使用该密钥和所有入参一起进行加密,加密的字符串会以默认参数:__hmacSha256 传递给目标服务,加密算法使用HmacSHA256算法,结果使用Base64转换成UTF8的字符串目标服务验证签名时需要将所有参数名进行去重然后使用参数值(宜搭内部使用TreeSet处理,调用时需要保证服务端参数名不重复)升序排序,每个参数值之间使用$分隔。
  9. 参数列表方法中需要用到的参数。
  10. 服务描述对服务作用或其他功能的说明信息。


特别说明:

  • 宜搭侧回调时的请求的HTTP类型为 POST
  • Body体的参数类型为:application/x-www-form-urlencoded; charset=UTF-8

即:content-type:application/x-www-form-urlencoded; charset=UTF-8

3.2 GATEWAY 类型的服务注册

在注册注册的页面,点击 新增服务 按钮,类型选择为 GATEWAY, 即可创建 GATEWAY 类型的服务注册。GATEWAY类型的服务注册,包含:类型、名称、使用人员(平台所有人 or 指定人员)、 Url 相对地址、参数列表、服务描述。下面针对创建一个完整的GATEWAY类型的服务注册所需信息进行详细介绍:

  1. 类型选择类型:GATEWAY,该类型仅面向阿里内部生态公司企业用户,普通企业用户请选择HTTP类型。
  2. 名称创建服务时,可以根据自己需要来填写。名称建议带有业务含义,以便在服务列表页面可以进行检索查询。
  3. 平台公共服务该勾选该栏目时,表示该服务注册可以为平台所有应用管理员使用。
  4. 使用人员可以理解为服务的管理者;且管理员可以对自己创建的服务进行查看、修改。
  5. Url相对地址:需要访问的 GATEWAY 接口对应的相对地址。
  6. 参数列表方法中需要用到的参数。
  7. 服务描述:对服务作用或其他功能的说明信

4. 本章小结

以上就是服务注册的全部内容,主要包括了 HTTP 类型的服务回调以及 GATEWAY 类型的服务回调的注册,但是操作完服务注册之后仅仅只是完成了第一步,接下来需要到具体的表单或者流程页面中进行引用配置了,详细的使用说明请参考服务回调

--------------------欢迎关注我们--------------------


Copyright © 2024钉钉(中国)信息技术有限公司和/或其关联公司浙ICP备18037475号-4