同步API触发器

生成一个HTTP服务的API接口，调用该接口会触发工作流运行，等待工作流运行结束，并返回输出结果。

创建的工作流可以在【流程管理】下的【工作流列表】或【API列表】找到。

注意：API只有启用后才能正常使用，否则会提示报错接口未启用。

入参

鉴权认证

目前支持一下三种鉴权方式：

• 没有鉴权

  所有请求都不需要做认证鉴权。

  例如：

  curl -d '{}' http://8.218.xxx.xx/v1/api/botman/test/sync
  {"response":{"code":0,"data":"botman.cc","msg":"","uid":"2023331691312889545691136"}}
  

• Token令牌鉴权

  在请求API时，需要在Header请求头带上Token令牌认证。

  例如：

  // 错误请求方式
  curl http://8.218.xxx.xx/v1/api/botman/test/sync
  {"response":{"error":{"code":"requestError.invalidParams","message":"Token is required"}}}
  

  // 正确请求方式
  curl -H'token:123456' http://8.218.xxx.xx/v1/api/admin/test/sync
  {"response":{"data":{"code":0,"msg":"ok"},"code":0,"msg":"","uid":"213995413340041216"}}
  

• 账号密码

  在请求API时，需要在Header请求头带上账号、密码认证。

  例如：

  // 错误请求方式
  curl http://8.218.xxx.xx/v1/api/botman/test/sync
  {"response":{"error":{"code":"requestError.invalidParams","message":"User/Password is required"}}}
  

  // 正确请求方式
  curl -H'user:botman' -H'password:123456' http://8.218.xxx.xx/v1/api/botman/test/sync
  {"response":{"data":{"code":0,"msg":"ok"},"code":0,"msg":"","uid":"213995413340041216"}}
  

API模块

API模块主要用来对接口进行分类，例如可以按照产品分不同的模块。

API方法

模块下的接口名称。

API方法

目前支持GET和POST两种方法。

调试数据

模拟用户请求接口是传递的POST参数，方便用户调试接口。

输出

默认不设置输出时，同步API的接口输出如下：

• 其中data是接口的输出，由于未设置，这里默认为空字符串。

• code和msg表示运行是的错误信息，正常默认为0。

• uid表示执行记录ID。

{
    "response": {
        "data": "",
        "code": 0,
        "msg": "",
        "uid": "213996969363910656"
    }
}

若设置输出（可使用【输出】应用），例如输出一个JSON结构：{"name":"hello world"}，其输出结果如下：

{
    "response": {
        "data": {
            "name": "hello world"
        },
        "code": 0,
        "msg": "",
        "uid": "213996969363910656"
    }
}