W5 API

WebHook

API : /api/v1/w5/webhook
Method : POST
Headers：

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| Content-Type | application/json | 是 | 声明 POST 类型为 JSON |

Request：

// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
    "text":"WEBHOOK 测试"
}

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| key | 988BE26B18B20729806FE5C3DF7388EB | 是 | API KEY，系统管理处生成 |

| uuid | 980b90b0-36d9-11eb-846f-dde86bba0048 | 是 | WEBHOOK UUID |

| text | WEBHOOK 测试 | 是 | 剧本接收内容 |

Request：

// 返回例子
{   
    "code": 9018,
    "msg": "KEY 不正确"
}

今日执行统计

API : /api/v1/w5/get/workflow_exec
Method : POST
Headers：

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| Content-Type | application/json | 是 | 声明 POST 类型为 JSON |

Request：

// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| key | 988BE26B18B20729806FE5C3DF7388EB | 是 | API KEY，系统管理处生成 |

| uuid | 980b90b0-36d9-11eb-846f-dde86bba0048 | 是 | 剧本 UUID |

Request：

// 返回例子
{
    "code": 0,
    "data": [
        {
            "time": "00",
            "value": 0
        },
        {
            "time": "01",
            "value": 0
        },
        {
            "time": "02",
            "value": 0
        },
        ...
    ],
    "msg": "Success"
}

剧本成功失败统计

API : /api/v1/w5/get/workflow_success_fail
Method : POST
Headers：

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| Content-Type | application/json | 是 | 声明 POST 类型为 JSON |

Request：

// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| key | 988BE26B18B20729806FE5C3DF7388EB | 是 | API KEY，系统管理处生成 |

| uuid | 980b90b0-36d9-11eb-846f-dde86bba0048 | 是 | 剧本 UUID |

Request：

// 返回例子
{
    "code": 0,
    "data": {
        "fail_sum": 0,
        "success_sum": 3
    },
    "msg": "Success"
}

剧本执行日记 TOP 100

API : /api/v1/w5/get/workflow_logs
Method : POST
Headers：

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| Content-Type | application/json | 是 | 声明 POST 类型为 JSON |

Request：

// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| key | 988BE26B18B20729806FE5C3DF7388EB | 是 | API KEY，系统管理处生成 |

| uuid | 980b90b0-36d9-11eb-846f-dde86bba0048 | 是 | 剧本 UUID |

Request：

// 返回例子
{
    "code": 0,
    "data": [
        {
            "app_name": "开始",
            "args": "",
            "create_time": "Sun, 17 Jan 2021 17:05:19 GMT",
            "id": 6696,
            "name": "未命名",
            "only_id": "202101171705189702431856",
            "result": "剧本开始执行",
            "status": 0,
            "uuid": "a5b211ea-58a2-11eb-9081-acbc32c7842d"
        },
        ....
    ],
    "msg": "Success"
}

| 参数 | 备注 | | —- | —- |

| app_name | APP 名称 |

| args | APP 参数 |

| id | 自增长ID |

| name | 剧本名称 |

| only_id | 执行批次号 |

| result | 执行结果 |

| status | 执行状态 |

| uuid | 剧本 UUID |

正在执行

API : /api/v1/w5/get/executing
Method : POST
Headers：

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| Content-Type | application/json | 是 | 声明 POST 类型为 JSON |

Request：

// 请求例子
{   
    "key":"988BE26B18B20729806FE5C3DF7388EB",
    "uuid":"980b90b0-36d9-11eb-846f-dde86bba0048",
}

| 参数 | 值 | 必填 | 备注 | | —- | —- | —- | —- |

| key | 988BE26B18B20729806FE5C3DF7388EB | 是 | API KEY，系统管理处生成 |

| uuid | 980b90b0-36d9-11eb-846f-dde86bba0048 | 否 | 剧本 UUID，不填写 查看全部 |

Request：

// 返回例子
{
    "code": 0,
    "data": {
        "sum": "12"
    },
    "msg": "Success"
}

错误码

| code | msg | | —- | —- |

| 0 | Success |

| 9014 | WebHook 内容不能为空 |

| 9015 | WebHook UUID 不能为空 |

| 9016 | WebHook UUID 不正确 |

| 9017 | kEY 不能为空 |

| 9018 | KEY 不正确 |

| 9020 | 工作流状态不可用 |