接口路径(新):http://api.okayapi.com/api/Super/User_Meta/Create
接口路径(旧):http://api.okayapi.com/?s=Super.User_Meta.Create
接口描述: 增 为用户创建一个新的元数据,不能重复创建
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Optaion | MIN: 32;MAX: 32 | 用户的UUID | |
token | String | Optaion | MIN: 64;MAX: 64 | 不需要用户登录 | |
key | String | Required | MIN: 1;MAX: 64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 | |
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 | |
data | ArrayJSON Format | Required | 创建时的初始化数据,需要JSON编码后传递。JSON在线解析及格式化验证 | ||
visiable | Enum | Optaion | private | Range: private/protected/public | 可见性,private为私有的,protected为受保护的,public为开放的 |
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$admin_uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$admin_token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$uuid='A5EA893548E493A0ABD6F64978AAA773';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('Super.User_Meta.Create',array('uuid'=>$uuid,'token'=>$token,'admin_uuid'=>$admin_uuid,'admin_token'=>$admin_token,'key'=>'schedule','data'=>json_encode(array("x"=>10,"y"=>20))));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:Super.User_Meta.Create
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0创建成功,1元数据已经存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/Super/User_Meta/Update
接口路径(旧):http://api.okayapi.com/?s=Super.User_Meta.Update
接口描述: 改 为用户增量更新指定的元数据,如果字段已存在则覆盖,没有则追加
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Optaion | MIN: 32;MAX: 32 | 用户的UUID | |
token | String | Optaion | MIN: 64;MAX: 64 | 不需要用户登录 | |
key | String | Required | MIN: 1;MAX: 64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 | |
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 | |
data | ArrayJSON Format | Required | 增量更新的数据,如果字段已存在则覆盖,需要JSON编码后传递。JSON在线解析及格式化验证 | ||
is_merge | Boolean | Optaion | true | 是否合并更新,1合并旧的数据并更新,2直接用新的数据进行替换 |
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$admin_uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$admin_token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$uuid='A5EA893548E493A0ABD6F64978AAA773';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('Super.User_Meta.Update',array('uuid'=>$uuid,'token'=>$token,'admin_uuid'=>$admin_uuid,'admin_token'=>$admin_token,'key'=>'schedule','data'=>json_encode(array("Mon."=>"shopping","Tues."=>"shopping"))));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:Super.User_Meta.Update
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0更新成功,1元数据不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/Super/User_Meta/Get
接口路径(旧):http://api.okayapi.com/?s=Super.User_Meta.Get
接口描述: 查 获取用户的元数据,可根据需要获取需要的字段
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Optaion | MIN: 32;MAX: 32 | 用户的UUID | |
token | String | Optaion | MIN: 64;MAX: 64 | 不需要用户登录 | |
key | String | Required | MIN: 1;MAX: 64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 | |
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 | |
fields | ArraySeperated with , | Optaion | 需要获取的字段,默认取全部,多个字段用英文逗号分割 |
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$admin_uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$admin_token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$uuid='A5EA893548E493A0ABD6F64978AAA773';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('Super.User_Meta.Get',array('uuid'=>$uuid,'token'=>$token,'admin_uuid'=>$admin_uuid,'admin_token'=>$admin_token,'key'=>'test'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[key] => test
[data] => Array ( [x] => 1000 [y] => 11111 )
[add_time] => 2019-02-14 18:19:16
[update_time] =>
)
[msg] => 小白开放接口:Super.User_Meta.Get
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0获取成功,1元数据不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
key | String | 元数据名称 |
object | Array | 元数据 |
add_time | String | 添加时间,格式为:Y-m-d H:i:s |
update_time | String | 最后更新时间,格式为:Y-m-d H:i:s,若从未更新则为空 |
接口路径(新):http://api.okayapi.com/api/Super/User_Meta/MultiGet
接口路径(旧):http://api.okayapi.com/?s=Super.User_Meta.MultiGet
接口描述: 增 批量获取,并且返回元数据内的全部字体,若元数据不存在则不返回
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Optaion | MIN: 32;MAX: 32 | 用户的UUID | |
token | String | Optaion | MIN: 64;MAX: 64 | 不需要用户登录 | |
keys | ArraySeperated with , | Required | MIN: 1;MAX: 100 | 元数据名称,多个名称用英文逗号分割 | |
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 |
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$admin_uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$admin_token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$uuid='A5EA893548E493A0ABD6F64978AAA773';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('Super.User_Meta.MultiGet',array('uuid'=>$uuid,'token'=>$token,'admin_uuid'=>$admin_uuid,'admin_token'=>$admin_token,'keys'=>'schedule,test'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[items] => Array
(
[0] => Array ( [key] => schedule [data] => Array ( [Mon.] => shopping [Tues.] => shopping ) [add_time] => 2019-02-14 18:26:26 [update_time] => 2019-02-14 18:27:37 )
[1] => Array ( [key] => test [data] => Array ( [x] => 1000 [y] => 11111 ) [add_time] => 2019-02-14 18:19:16 [update_time] => )
)
)
[msg] => 小白开放接口:Super.User_Meta.MultiGet
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0获取成功 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
items[].key | String | 元数据名称 |
items[].data | Object | 元数据,包括全部字段,不过滤 |
items[].add_time | String | 添加时间,格式为:Y-m-d H:i:s |
items[].update_time | String | 最后更新时间,格式为:Y-m-d H:i:s,若从未更新则为空 |
接口路径(新):http://api.okayapi.com/api/Super/User_Meta/Delete
接口路径(旧):http://api.okayapi.com/?s=Super.User_Meta.Delete
接口描述: 删 删除用户的元数据
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Optaion | MIN: 32;MAX: 32 | 用户的UUID | |
token | String | Optaion | MIN: 64;MAX: 64 | 不需要用户登录 | |
key | String | Required | MIN: 1;MAX: 64 | 元数据唯一名称,可以由中文/数字/字母等组成,例如:2019_数据 | |
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 |
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$admin_uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$admin_token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$uuid='A5EA893548E493A0ABD6F64978AAA773';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('Super.User_Meta.Delete',array('uuid'=>$uuid,'token'=>$token,'admin_uuid'=>$admin_uuid,'admin_token'=>$admin_token,'key'=>'schedule'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
)
[msg] => 小白开放接口:Super.User_Meta.Delete
)
*/
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0删除成功,1元数据不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Mar/29/2024 04:23:34