接口路径(新):http://hd215.api.yesapi.cn/api/App/Main_Meta/Create
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.Main_Meta.Create
接口描述: 增 为应用创建一个新的元数据,不能重复创建
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 最小:32;最大:32 | UUID,全局唯一用户ID,查看全部注册会员。当前接口不需要,可忽略。 | |
token | 字符串 | 可选 | 最小:64;最大:64 | 会话凭证,当前接口不需要,可忽略。 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
key | 字符串 | 必须 | 最小:1;最大:64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 | |
data | 字符串JSON格式 | 必须 | 创建时的初始化数据,需要JSON编码后传递。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.Main_Meta.Create&key=test&data={"x":10,"y":20}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Meta.Create',array('key'=>'schedule','data'=>json_encode(array("Mon."=>"swim","Tues."=>"shopping"))));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:App.Main_Meta.Create
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0创建成功,1元数据已经存在或权限不足 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) |
接口路径(新):http://hd215.api.yesapi.cn/api/App/Main_Meta/Update
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.Main_Meta.Update
接口描述: 改 为应用增量更新指定的元数据,如果字段已存在则覆盖,没有则追加
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 最小:32;最大:32 | UUID,全局唯一用户ID,查看全部注册会员。当前接口不需要,可忽略。 | |
token | 字符串 | 可选 | 最小:64;最大:64 | 会话凭证,当前接口不需要,可忽略。 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
key | 字符串 | 必须 | 最小:1;最大:64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 | |
data | 字符串JSON格式 | 必须 | 增量更新的数据,如果字段已存在则覆盖,需要JSON编码后传递。JSON在线解析及格式化验证 | ||
is_merge | 布尔型 | 可选 | true | 是否合并更新,1合并旧的数据并更新,2直接用新的数据进行替换 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.Main_Meta.Update&key=test&data={"z":5}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Meta.Update',array('key'=>'schedule','data'=>json_encode(array("Mon."=>"shopping","Tues."=>"shopping"))));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:App.Main_Meta.Update
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0更新成功,1元数据不存在或权限不足 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) |
接口路径(新):http://hd215.api.yesapi.cn/api/App/Main_Meta/Get
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.Main_Meta.Get
接口描述: 查 获取应用元数据,可根据需要获取需要的字段
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 最小:32;最大:32 | UUID,全局唯一用户ID,查看全部注册会员。当前接口不需要,可忽略。 | |
token | 字符串 | 可选 | 最小:64;最大:64 | 会话凭证,当前接口不需要,可忽略。 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
key | 字符串 | 必须 | 最小:1;最大:64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 | |
fields | 字符串用,分割 | 可选 | 需要获取的字段,默认取全部,多个字段用英文逗号分割 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.Main_Meta.Get&key=test&data={"x":10,"y":20}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"key": "test",
"data": {
"x": 10,
"y": 20
},
"add_time": "2018-07-07 22:22:43",
"update_time": ""
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Meta.Get', array('key'=>'test','fields'=>'x'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[key] => test
[data] =>
Array
(
[x] => 10
)
[add_time] => 2019-02-03 00:49:22
[update_time] =>
)
[msg] => 小白开放接口:App.Main_Meta.Get
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0获取成功,1元数据不存在或权限不足 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.key | 字符串 | 元数据名称 |
data.data | 对象 | 元数据 |
data.add_time | 字符串 | 添加时间,格式为:Y-m-d H:i:s |
data.update_time | 字符串 | 最后更新时间,格式为:Y-m-d H:i:s,若从未更新则为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) |
接口路径(新):http://hd215.api.yesapi.cn/api/App/Main_Meta/MultiGet
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.Main_Meta.MultiGet
接口描述: 查 批量获取应用元数据,并且返回元数据内的全部字体,若元数据不存在则不返回
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 最小:32;最大:32 | UUID,全局唯一用户ID,查看全部注册会员。当前接口不需要,可忽略。 | |
token | 字符串 | 可选 | 最小:64;最大:64 | 会话凭证,当前接口不需要,可忽略。 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
keys | 字符串用,分割 | 必须 | 最小:1;最大:100 | 元数据名称,多个名称用英文逗号分割 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.Main_Meta.MultiGet&keys=test1,test2&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
{
"key": "test1",
"data": {
"z": 5
},
"add_time": "2018-07-07 22:27:55",
"update_time": ""
},
{
"key": "test2",
"data": {
"z": 5
},
"add_time": "2018-07-07 22:27:58",
"update_time": ""
}
]
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Meta.MultiGet',array('keys'=>'room1,room2'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[items] => Array
(
[0] => Array
(
[key] => room1
[data] => Array( [x] => 50 [y] => 20 )
[add_time] => 2019-02-14 16:41:11
[update_time] =>
)
[1] => Array
(
[key] => room2
[data] => Array ( [x] => 50 [y] => 70 )
[add_time] => 2019-02-14 16:41:19
[update_time] =>
)
)
)
[msg] => 小白开放接口:App.Main_Meta.MultiGet
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0获取成功 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.items[].key | 字符串 | 元数据名称 |
data.items[].data | 对象 | 元数据,包括全部字段,不过滤 |
data.items[].add_time | 字符串 | 添加时间,格式为:Y-m-d H:i:s |
data.items[].update_time | 字符串 | 最后更新时间,格式为:Y-m-d H:i:s,若从未更新则为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) |
接口路径(新):http://hd215.api.yesapi.cn/api/App/Main_Meta/Delete
接口路径(旧):http://hd215.api.yesapi.cn/?s=App.Main_Meta.Delete
接口描述: 删 删除应用元数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 最小:32;最大:32 | UUID,全局唯一用户ID,查看全部注册会员。当前接口不需要,可忽略。 | |
token | 字符串 | 可选 | 最小:64;最大:64 | 会话凭证,当前接口不需要,可忽略。 | |
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
key | 字符串 | 必须 | 最小:1;最大:64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.Main_Meta.Delete&key=test&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": ""
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.Main_Meta.Delete',array('key'=>'schedule'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:App.Main_Meta.Delete
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0删除成功,1元数据不存在或权限不足 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) |
特别注意:当前 hd215.api.yesapi.cn 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次