了解连接器函数模式的参数透传与返回值格式。
概述
每一个接口如果页面 UI 满足不了,都可以切换代码模式(函数模式)。函数参数透传对应页面配置参数以及授权参数。
参数透传
函数模式中可以通过 syncArg 获取以下参数:
| 参数 | 类型 | 说明 |
|---|---|---|
auth_data |
Map | 授权配置参数与授权接口返回参数 |
input_data |
Map | 页面输入参数 |
tenantId |
String | 租户标识 |
connectorKey |
String | 连接器标识 |
operation |
String | 当前操作 |
connectionId |
String | 连接实例标识 |
type |
String | 类型 |
extra |
Map | 扩展参数 |
http |
Map | HTTP 上下文 |
Map<String, Object> authData = (Map<String, Object>) syncArg.get("auth_data");
Map<String, Object> inputData = (Map<String, Object>) syncArg.get("input_data");
String tenantId = (String) syncArg.get("tenantId");
String connectorKey = (String) syncArg.get("connectorKey");
String operation = (String) syncArg.get("operation");
String connectionId = (String) syncArg.get("connectionId");
String type = (String) syncArg.get("type");
Map<String, Object> extra = (Map<String, Object>) syncArg.get("extra");
Map<String, Object> http = (Map<String, Object>) syncArg.get("http");
Trigger 返回格式
Trigger 返回需要返回数据列表。
字段说明:
dataItems:必须,触发出来的数据列表privateKeys:推荐,去重主键字段nameKeys:推荐,调试展示名称字段conditions:推荐,下一次轮询继续查询用
return [
outputData: [
triggerOperation: "instant.created",
dataItems: [
[
id: "1",
event: "created",
name: "test order"
],
[
id: "2",
event: "created",
name: "test order 2"
]
],
privateKeys: ["id"],
nameKeys: ["name"],
conditions: [
nextCursor: "cursor_123"
]
]
]
获取认证授权地址
return [
outputData: [
authorizeUrl: "https://example.com/oauth/authorize?client_id=xxx&state=xxx&redirect_uri=xxx"
]
]
获取 Token
return [
outputData: [
access_token: "access_token_xxx",
refresh_token: "refresh_token_xxx",
token_type: "Bearer",
expires_in: 7200,
scope: "crm"
]
]
刷新 Token
return [
outputData: [
access_token: "new_access_token_xxx",
refresh_token: "new_refresh_token_xxx",
token_type: "Bearer",
expires_in: 7200
]
]
普通接口返回
普通接口函数返回 outputData:
return [
outputData: [
id: "123",
name: "test",
status: "success"
]
]