复杂场景下第三方接口对接-函数API

1.      场景描述

第三方接口简单的代理转发可以通过通用API来实现,如果涉及参数的转换或者多个接口的编排调用,通用API则无法实现,这时需要一种自定义编排的方法来注册接口。

2.      场景分析

函数API可以通过编写函数脚本来实现复杂场景下的参数转化和多接口调用编排,利用内部实现的工具类,通过JS脚本可以实现灵活的编排调用。

3.      示例前置条件

[服务集成/API工厂/环境配置/密码箱]页面及[服务集成/API工厂/环境配置/环境变量]页面分别添加编写函数API时需要用到的环境变量和密码箱。

4.      示例详细步骤

  1. [服务集成/API工厂/API管理]页面,单击<API注册>按钮,选择注册类型为“函数API”,进入函数API设计页面,配置函数API基本属性。

图-1 配置函数API基本属性

 

  1. 配置完基本属性后,单击<下一步>按钮,进入函数API的参数配置页面。

图-2 参数配置

 

  1. 单击<下一步>,编写JS脚本。

图-3 编写JS脚本

 

  1. 单击<下一步>,查看配置的函数API的整体信息。

图-4 预览信息

 

  1. 单击<保存>按钮,返回API管理页面。在API管理页面可以看到新增的API。接下来的测试、部署、授权操作,可参考将数据库字段共享开放成接口场景-数据API中数据API“示例详细步骤”中的第9步。