接入指南
平台网站应用是指主平台及各子系统平台的功能或模块。
此类接口可为平台网站应用提供用户信息管理、企业信息管理服务支撑,开发者可以利用这些接口实现用户企业信息管理。
详细接口可参考用户管理接口、企业管理接口,具体使用示例如下:
用户信息管理
主要提供用户信息管理服务,如用户信息查询、更新用户信息等
接口名称:用户信息查询
使用场景:获取用户有关信息时,可以调用该接口。
请求示例:https://uc.ms.bearingcloud.cn/1/user/get?client_id=&ts=&sign=&user_id=1
请求参数说明
参数名 | 是否必须 | 类型 | 参数描述 |
---|---|---|---|
user_id | 否 | long | 用户ID |
account | 否 | string | 用户账户 |
mobile | 否 | string | 用户手机号 |
否 | string | 用户邮箱 | |
open_id | 否 | string | 用户openId |
注: 以上参数必选其一
返回成功示例:
{ "code": 200, "data": { "account": "test_account", "create_time": "2010-01-01 00:00:00", "email": "test@163.com", "fullname": "管理员", "is_admin": true, "is_email_true": "1", "is_mobile_true": "1", "mark": 5, "mobile": "18800010001", "open_id": "fc8568a6f1cf4b5297ad64d0bef81a6c", "org_id": 5100941, "phone": "010-12345678", "picture": "http://img.xxx.com/1.jpg", "sex": "1", "short_account": "zhangsan", "status": "1", "system_id": 100, "update_time": "2010-01-01 00:00:00", "update_times": 1, "user_id": 1393817040 }, "msg": "" }
返回失败示例:
{ "code": 1001, "data": null, "msg": "用户不存在" }
接口名称:更新用户信息
使用场景:更新用户相关信息时,可以调用该接口。
请求示例:https://uc.ms.bearingcloud.cn/1/user/update?client_id=&ts=&sign=
请求参数说明
参数名 | 是否必须 | 类型 | 参数描述 |
---|---|---|---|
user_id | 否 | long | 用户ID |
fullname | 否 | string | 用户姓名 |
注:更新用户信息,如果不需要更新的字段,请求内容就不要带该字段
Post请求示例:
{ "fullname": "张三", "user_id": 1393817040 }
返回成功示例:
{ "code": 200, "data": true, "msg": "" }
返回失败示例:
{ "code": 1100, "data": null, "msg": "用户姓名格式不正确" }
企业信息管理
主要提供企业信息管理服务,如企业基本信息查询、更新企业基本信息等。
接口名称:企业基本信息查询
使用场景:要获取企业基本信息时,可以调用该接口。
请求示例: https://uc.ms.bearingcloud.cn/1/org/get?client_id=&ts=&sign=&org_id=1
请求参数说明:
参数名 | 是否必须 | 类型 | 参数描述 |
---|---|---|---|
org_id | 否 | long | 企业ID |
open_id | 否 | string | 企业openId |
注:以上参数必选其一。
返回成功示例:
{ "code": 200, "data": { "abbreviation_name": "北京测试", "address": "中关村", "city": "北京市", "connecter": "张三", "county": "海淀区", "create_time": "2010-01-01 00:00:00", "email": "test@163.com", "fax": "010-12345678", "homephone": "010-12345678", "industry": "制造业", "industry2": "通用设备制造业", "invitited_code": "5100941", "is_public": "1", "logo": "/upload/7801080/7801080_16516.jpg", "mark": 5, "name": "北京测试有限公司", "open_id": "fe0e15b0b59b11e8908a0cda411db1", "org_id": 5100941, "postcode": "100010", "product": "电子设备", "province": "北京", "system_id": 100, "tel": "18800010001", "update_time": "2010-01-01 00:00:00" }, "msg": "" }
返回失败示例:
{ "code": 1102, "data": null, "msg": "企业不存在" }
接口名称:更新企业基本信息
使用场景:更新企业基本信息时,可以调用该接口。
请求示例: https://uc.ms.bearingcloud.cn/1/org/update?client_id=&ts=&sign=
请求参数说明:
参数名 | 是否必须 | 类型 | 参数描述 |
---|---|---|---|
org_id | 否 | long | 企业ID |
name | 否 | string | 企业名称,校验唯一性 |
Post请求示例:
{ "code": 200, "data": true, "msg": "" }
返回失败示例:
{ "code": 1107, "data": null, "msg": "企业名称格式不正确" }