API

添加云函数

1、点击云函数下方的"添加API"按钮，在API模板界面点击“新建空白API”，在弹出窗口中输入API名称，点击确定。

2、在配置页配置输入、输出参数、并填写配置表。

3、切换至“编程”标签，现在您可以在代码编辑器中定义云函数了。如果你熟悉JS脚本语言，编写API非常简单，你只需要在run方法中补充您的业务逻辑代码就可以了。

run方法包含了3个参数

input：输入参数。通过“input.key”调用配置中添加的输入参数。

output：输出参数。通过“output.key”调用配置中添加的输出参数。

modules：可调用模块。

详情请参考API开发文档_白码。

1、新增云函数

2、编辑云函数的配置项

3、在编辑中编写代码

4、平台支持调试api

通过在线调试工具测试结果(测试前请请先将代码保存，并保持开启状态)：

调用云函数

1、在调用云函数前，请确保云函数测试无误可用，并将云函数启用(在云函数的基本信息中将状态开关打开即可。

2、创建一个功能，进入功能编辑页，添加一个步骤，类型选择“API”，操作选择“自定义api”，模板选择开启的云函数。

3、点击此步骤的编辑，即可看到此API包含的输入输出参数。现在你可以将输入参数设为其他步骤中的相关数值，以传入云函数

4、创建一个步骤来使用API的输出参数。

api返回的处理时长

webhook

添加webhook

1、点击webhook下方的"添加API"按钮，在API模板界面点击“新建空白API”，在弹出窗口中输入API名称，设定webhook路径(此路径为第三方发起该webhook请求的路径)，点击确定。

2、在配置页填写配置表。

3、切换至“编程”标签，现在您可以在代码编辑器中定义webhook了。如果你熟悉JS脚本语言，编写API非常简单，你只需要在hook方法中补充您的业务逻辑代码就可以了。

hook方法包含了3个参数：

req：请求对象，可以获取网络请求中的参数。

resp：回应对象，可以将webhook的执行结果返回到请求方。

modules：可调用模块。

详情请参考API开发文档_白码。

由于webhook属于被动式接收数据，而功能属于主动式处理，因此不支持在功能步骤中处理webhook接收的数据。需要在webhook中通$modules.program.exec（$flow,$form）调用一个功能来记录处理接收的数据。

这里以实现在接收企业微信接口文档 - 企业微信开发者中心回调数据的功能为例介绍webhook具体使用流程：根据企业微信API模板创建一个API实现记录成员添加外部联系人信息。

API配置如下：

代码如下：

调用功能如下：

调用webhook

以上文配置的webhook为例：

1、保证API编写无误后，将API保持开启状态。

2、在第三方配置此webhook的路径。

3、在第三方触发回调事件，在白码数据库查看回调信息。

1）使用企业微信成员账号将微信用户“添加为联系人”

2）在数据库中查看回调数据