首页|接入文档
API v1

远程功能

API v1

远程功能

远程功能模块支持三类数据:远程变量(RemoteVar)远程数据(RemoteData)远程函数(RemoteFunc)。这些内容由开发者在控制台配置,客户端按 keyfunc_name 读取、操作或调用。


GET /api/v1/af/remote_var — 获取远程变量

key 读取远程变量值。若变量设置了"需要登录",则必须传 tokencard 参数。

请求参数(Query)

参数名类型必填说明
app_keystring软件 App Key
keystring远程变量的 key
cardstring条件变量要求登录时必填
tokenstring条件变量要求登录时必填
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

返回数据(result)

字段名类型说明
valuestring远程变量的值

GET /api/v1/af/remote_data — 获取远程数据

key 读取远程数据内容。

请求参数(Query)

参数名类型必填说明
app_keystring软件 App Key
keystring数据的 key
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

返回数据(result)

字段名类型说明
valuestring数据内容

POST /api/v1/af/remote_data — 增/改/删远程数据

通过 action 参数指定操作类型:create(新建)/ update(修改)/ delete(删除)。

请求参数

参数名类型必填说明
app_keystring软件 App Key
actionstring操作类型:create / update / delete
keystring数据的 key
valuestring条件actioncreate/update 时必填
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

成功时 result 字段不存在。


POST /api/v1/af/remote_func — 调用远程函数

func_name 调用控制台配置的远程函数。函数体必须是同步 JS 函数表达式,例如:function(token, params, context) { return { ok: true, params } }

请求参数

参数名类型必填说明
app_keystring软件 App Key
func_namestring远程函数名称
paramsstringJSON 字符串,函数第二个参数会收到解析后的对象
cardstring卡密字符串,会参与签名并作为第三个参数 context.card 传入
tokenstring登录 token,会作为函数第一个参数传入
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

返回数据(result)

字段名类型说明
valueany远程函数返回值,未返回时为 null