用户操作
获取用户详情
接口
GET https://cloud.minapp.com/oserve/v1/miniapp/user-profile/:profile_id/
其中 (已废弃):profile_id
需替换为用户 ID
GET https://cloud.minapp.com/oserve/v1/miniapp/user-profile/?user_id={{ user_id }}
其中 user_id
可从用户列表中获取。
代码示例
curl -X GET \
-H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
-H "Content-Type: application/json" \
https://cloud.minapp.com/oserve/v1/miniapp/user-profile/?user_id=55019
var opt = {
uri: 'https://cloud.minapp.com/oserve/v1/miniapp/user-profile/?user_id=4271xx', // 4271xx 对应 :user_id
method: 'GET',
headers: {
Authorization: `Bearer ${token}`,
}
}
request(opt, function(err, res, body) {
console.log(body)
})
<?php
$user_id = '4271xx'; // 用户 ID
$url = "https://cloud.minapp.com/oserve/v1/miniapp/user-profile/?user_id={$user_id}";
$ch = curl_init();
$header = array(
"Authorization: Bearer {$token}",
'Content-Type: application/json; charset=utf-8'
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
$res = curl_exec($ch);
curl_close($ch);
返回示例
{
"avatar": "https://media.ifanrusercontent.com/media/tavatar/55/c3/55c3dbebcc61891be10d29ded808c84a01dxxxxx.jpg",
"city": "Guangzhou",
"country": "China",
"created_at": 1504504504,
"gender": 1,
"id": 550xx,
"nickname": "PCG",
"openid": "onzns0KsLKFyg3-VcW0GwTE6xxxx",
"unionid": "onzns0KsLKFyg3-VcW0GwTE6xxxx",
"province": "Guangdong",
"user_group": [
137
],
"user_id": 366197xx
}
获取用户列表
接口
GET https://cloud.minapp.com/oserve/v1/miniapp/user-profile/
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
created_at | String | N | 用户创建的时间,值为时间戳。查询创建时间大于等于 2017-01-01 的用户 created_atgte=1483228800 ,查询创建时间小于等于 2017-01-01 的用户:created_at lte=1483228800 |
gender | Number | N | 户的性别,其中 1 表示男,2 表示女 |
group | String | N | 给定用户组 ID 查询在用户组下的用户列表。只支持 in 查询:groupin=258,360 |
limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 |
nickname | String | N | 用户的微信昵称,支持等值查询 nickname=Tom , 模糊查询 nicknamecontains=Tom |
offset | Number | N | 设置返回资源的起始偏移值,默认为 0 |
openid | String | N | 用户的 OpenID |
order_by | String | N | 排序(支持 created_at 进行排序) |
unionid | String | N | 用户的 UnionID |
user_id | String | N | 用户 ID (对应 _userprofile 表中的 id 字段) |
代码示例
curl -X GET \
-H "Authorization: Bearer 58f6cd9f84b1b0c04941fbd4d87bc5f14a785107" \
-H "Content-Type: application/json" \
-G \
-d nickname__contains=Tom \
-d gender=1 \
-d created_at__gt=1483228800 \
-d order_by=-created_at \
https://cloud.minapp.com/oserve/v1/miniapp/user-profile/
var request = require('request');
var opt = {
uri: 'https://cloud.minapp.com/oserve/v1/miniapp/user-profile/',
method: 'GET',
headers: {
Authorization: `Bearer ${token}`,
},
qs: { // query string, 被附加到uri的参数
nickname__contains: 'username',
gender: 1,
created_at__gte: 1483228800,
user_id: '363953xx',
order_by: '-created_at'
}
}
request(opt, function(err, res, body) {
console.log(body)
})
<?php
$query_data = array(
'nickname__contains' => 'Tom',
'gender' => 1,
'created_at__gte' => 1483228800,
'order_by' => '-created_at'
);
$query_string = http_build_query($query_data);
$url = "https://cloud.minapp.com/oserve/v1/miniapp/user-profile/?".$query_string;
$ch = curl_init();
$header = array(
"Authorization: Bearer {$token}",
'Content-Type: application/json; charset=utf-8'
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
$res = curl_exec($ch);
curl_close($ch);
返回示例
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [{
"avatar": "https://media.ifanrusercontent.com/media/tavatar/55/c3/55c3dbebcc61891be10d29ded808c84a01dxxxxx.jpg",
"city": "Guangzhou",
"country": "China",
"created_at": 1504504504,
"gender": 1,
"id": 550xx,
"nickname": "PCG",
"openid": "onzns0KsLKFyg3-VcW0GwTE6xxxx",
"unionid": "onzns0KsLKFyg3-VcW0GwTE6xxxx",
"province": "Guangdong",
"user_group": [
137
],
"user_id": 366197xx
}]
}
用户信息处理
支持自定义字段的查询,更新。
批量获取用户信息
接口
(后续将废弃该接口,推荐使用以下接口)GET https://cloud.minapp.com/oserve/v1/user/info/
GET https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
where | String | N | 查询语句,参数值应经过 JSON 编码为 JSONString 后,再经过 URL 编码 |
order_by | String | N | 以下字段不支持排序:gender, country, province, city, language |
limit | Number | N | 限制返回资源的个数,默认为 20 条,最大可设置为 1000 |
offset | Number | N | 设置返回资源的起始偏移值,默认为 0 |
where 字段的详细说明请查看:数据模块:数据操作。
代码示例
curl -X GET \
-H "Authorization: Bearer 35919068aa799eccdef160e1da4bf21381" \
--data-urlencode '{"test": {"$eq":"test"}}'\
https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/
var request = require("request");
var options = {
method: 'GET',
url: 'https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/',
headers:
{
'Content-Type': 'application/json',
Authorization: 'Bearer 35919068aa799eccf19160e1da4bf2138'
},
qs: {
where: JSON.stringify({"test": {"$eq": "test"}})
}
};
var req = request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$token = '35919068aa799eccdef19160e1da4bf21381';
$url = "https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/?";
$ch = curl_init();
$header = array(
"Authorization: Bearer {$token}",
'Content-Type: application/json; charset=utf-8'
);
$condition = array(
'where' => json_encode(['test' => ['$eq' => 'test']]),
);
$url .= http_build_query($condition);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);
if ($err) {
echo "CURL Error #:" . $err;
} else {
echo $response;
}
返回示例
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 2
},
"objects": [
{
"avatar": "https://media.ifanrusercontent.com/tavatar/73/b2/73b23fbd584699bb31a0317c9d4425dcba9xxxx.jpg",
"city": "广州",
"country": "中国",
"created_at": 1542364387,
"created_by": 64501217,
"gender": 1,
"id": 64501217,
"is_authorized": true,
"language": "zh_CN",
"nickname": "你今天真好看",
"openid": "o0b495YcphSE24RbTl7K9dMx_QAA",
"province": "广东",
"test": "test",
"unionid": null,
"updated_at": 1542872767
},
{
"avatar": "https://media.ifanrusercontent.com/tavatar/4d/7c/4d7c5418b262bfa2250fd3b70789ba9d0c6e4603.jpg",
"city": "广州",
"country": "中国",
"created_at": 1542858732,
"created_by": 70695404,
"gender": 0,
"id": 70695404,
"is_authorized": true,
"language": "zh_CN",
"nickname": "你也是",
"openid": "o0b495agcnGojMQbCnlB9AV6OeDw",
"province": "广东",
"test": "test",
"unionid": null,
"updated_at": 1542958030
}
]
}
状态码说明
200
: 成功。
400
: where 中的操作符或值错误,排序字段不支持。
401
: 未授权,请检查请求头中的 Authorization 字段是否正确。
获取单个用户信息
接口
(后续将废弃该接口,推荐使用以下接口)GET https://cloud.minapp.com/oserve/v1/user/info/:id/
GET https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/:id/
其中 :id
是用户在 _userprofile
表中的 id
。
代码示例
curl -X GET \
-H "Authorization: Bearer 35919068aa799eccdef19160e1da4bf21381d2a2" \
https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/70695404/
var request = require("request");
var options = {
method: 'GET',
url: 'https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/70695404/',
headers:
{
'Content-Type': 'application/json',
Authorization: 'Bearer 35919068aa799eccdef19160e1da4bf21381d2a2'
},
};
var req = request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$token = '35919068aa799eccdef19160e1da4bf21381d2a2';
$url = "https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/70695404/";
$ch = curl_init();
$header = array(
"Authorization: Bearer {$token}",
'Content-Type: application/json; charset=utf-8'
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);
if ($err) {
echo "CURL Error #:" . $err;
} else {
echo $response;
}
返回示例
{
"avatar": "https://media.ifanrusercontent.com/tavatar/73/b2/73b23fbd584699bb31a0317c9d4425dcba9a.jpg",
"city": "广州",
"country": "中国",
"created_at": 1542364387,
"created_by": 88888,
"gender": 1,
"id": 88888,
"is_authorized": true,
"language": "zh_CN",
"nickname": "你今天真好看",
"openid": "o0b495YcphSE24RbTl7K9dMx_A",
"province": "广东",
"test": "test",
"unionid": null,
"updated_at": 1542872767
}
状态码说明
200
: 成功。
401
: 未授权,请检查请求头中的 Authorization 字段是否正确。
404
: 用户不存在。
更新单个用户信息
接口
(后续将废弃该接口,推荐使用以下接口)PUT https://cloud.minapp.com/oserve/v1/user/info/:id/
PUT https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/:id/
其中 :id
是用户在 _userprofile
表中的 id
。
代码示例
curl -X PUT \
https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/70695404/ \
-H 'Authorization: Bearer 35919068aa799eccdef19160e1da4bf21381d2a2' \
-H 'Content-Type: application/json' \
-d '{"test": "test"}'
var request = require("request");
var options = {
method: 'PUT',
url: 'https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/70695404/',
headers:
{
'Content-Type': 'application/json',
Authorization: 'Bearer 35919068aa799eccdef19160e1da4bf21381d2a2'
},
body: { "test": "test" },
json: true
};
var req = request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$token = '35919068aa799eccdef19160e1da4bf21381d2a2';
$url = "https://cloud.minapp.com/oserve/v1.9/miniapp/user_profile/70695404/";
$ch = curl_init();
$header = array(
"Authorization: Bearer {$token}",
'Content-Type: application/json; charset=utf-8'
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\"test\": \"test\"}");
$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);
if ($err) {
echo "CURL Error #:" . $err;
} else {
echo $response;
}
返回示例
{
"avatar": "https://media.ifanrusercontent.com/tavatar/4d/7c/4d7c5418b262bfa2250fd3b70789ba9d0c6e4603.jpg",
"city": "广州",
"country": "中国",
"created_at": 1542858732,
"created_by": 70695404,
"gender": 1,
"id": 70695404,
"is_authorized": true,
"language": "zh_CN",
"nickname": "Guoch",
"openid": "o0b495agcnGojMQbCnlB9AV6OeDw",
"province": "广东",
"test": "changed_from_open_api",
"unionid": null,
"updated_at": 1542957870
}
状态码说明
200
: 成功。
400
: 字段类型不匹配,更新非自定义字段或不存在的字段。
401
: 未授权,请检查请求头中的 Authorization 字段是否正确。
404
: 用户不存在。