泡椒云网络验证系统文档

# 高级功能

# 获取远程变量

# 请求地址

GET-http://api.paojiaoyun.com/v1/af/remote_var

# 请求参数

参数名 是否必需 类型 参数说明
app_key 是 string 软件的app_key
card 否 string 登录的卡密，如远程变量设置了校验token，则必传
key 是 string 远程变量名（不超过64位字符）
nonce 是 string 不超过36位的随机字符串（建议用UUID）详细解释
timestamp 是 int64 时间戳，秒级（10位数）
token 否 string 登录成功后返回的令牌，如远程变量设置了校验token，则必传
sign 是 string 签名

# 响应示例

{
    "code": 0,
    "message": "ok",
    "result": {
        "value": "123"
    }
}
1
2
3
4
5
6
7

# 响应参数

参数名 类型 参数说明
code int 返回码，0表示正确，详细参照返回码对照表
message string 请求出错时的错误信息
result object 请求正确时，若有额外数据要返回，则结果封装在该字段。若无额外数据，则无此字段。
value string 远程变量值

# 获取远程数据

# 请求地址

GET-http://api.paojiaoyun.com/v1/af/remote_data

# 请求参数

参数名 是否必需 类型 参数说明
app_key 是 string 软件的app_key
key 是 string 远程数据key（不超过64位字符）
nonce 是 string 不超过36位的随机字符串（建议用UUID）详细解释
timestamp 是 int64 时间戳，秒级（10位数）
sign 是 string 签名

# 响应示例

{
    "code": 0,
    "message": "ok",
    "result": {
        "value": "123123"
    }
}
1
2
3
4
5
6
7

# 响应参数

参数名 类型 参数说明
code int 返回码，0表示正确，详细参照返回码对照表
message string 请求出错时的错误信息
result object 请求正确时，若有额外数据要返回，则结果封装在该字段。若无额外数据，则无此字段。
value string 远程数据值

# 操作远程数据（增改删）

# 请求地址

POST-http://api.paojiaoyun.com/v1/af/remote_data

# 请求参数

参数名 是否必需 类型 参数说明
action 是 string 动作，只能是（create 或 update 或 delete）
app_key 是 string 软件的app_key
key 是 string 远程数据key（不超过64位字符）
nonce 是 string 不超过36位的随机字符串（建议用UUID）详细解释
timestamp 是 int64 时间戳，秒级（10位数）
value 否 string 远程数据值（不超过256位字符）。
在action为delete时不要传，也不参与签名计算
sign 是 string 签名

# 响应示例

{
    "code": 0,
    "message": "ok"
}
1
2
3
4

# 响应参数

参数名 类型 参数说明
code int 返回码，0表示正确，详细参照返回码对照表
message string 请求出错时的错误信息

# 执行远程函数

# 请求地址

POST-http://api.paojiaoyun.com/v1/af/call_remote_func

# 请求参数

参数名 是否必需 类型 参数说明
app_key 是 string 软件的app_key
func_name 是 string 远程函数名（不超过64位字符）
nonce 是 string 不超过36位的随机字符串（建议用UUID）详细解释
params 否 string 远程函数的参数，json列表字符串（长度不超过256位）
timestamp 是 int64 时间戳，秒级（10位数）
sign 是 string 签名

参数 params 详细说明

参数列表，如果远程函数不需要参数，则可不传。
格式为json列表，然后序列化成字符串。

# 响应示例

{
    "code": 0,
    "message": "ok",
    "result": {
        "return": "{\"return\":\"ABC\"}"
    }
}
1
2
3
4
5
6
7

请求和响应示例

【例1】远程函数定义为：

function add(a, b) {
  return a + b;
}
1
2
3

如params为："[1, 2]" 则return为："{\"return\":3}"

【例2】远程函数定义为：

function str_to_upper(str) {
  return str.toUpperCase();
}
1
2
3

如params为："[\"abc\"]" 则return为："{\"return\":\"ABC\"}"

# 响应参数

参数名 类型 参数说明
code int 返回码，0表示正确，详细参照返回码对照表
message string 请求出错时的错误信息
result object 请求正确时，若有额外数据要返回，则结果封装在该字段。若无额外数据，则无此字段。
return string json对象字符串，使用需先反序列化

← Auto.js 快速接入 →