【无标题】

最新推荐文章于 2023-10-26 17:32:37 发布
最新推荐文章于 2023-10-26 17:32:37 发布
阅读量1k 收藏
点赞数
文章标签： java 服务器 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/it_manman/article/details/131176891
版权

文章目录

1.授权认证

功能描述

云眸平台所有REST API的调用都需要身份认证，采用Client Credentials授权方式

接口定义

接口地址：https://api2.hik-cloud.com/oauth/token

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填备注
client_id客户端IDString32是使用云眸系统管理员账号登录开放平台门户网站open2.hik-cloud.com，进入秘钥管理页面查看获取
client_secret访问密钥String32是使用云眸账号登录开放平台门户网站open2.hik-cloud.com，进入秘钥管理页面查看获取
grant_type认证模式String32是目前仅支持client_credentials
scope权限范围Srting32否可选填app

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
access_token访问令牌String32是
token_type令牌类型String32是
expires_in过期时间(秒)Long8是
scope权限范围String32否

实现示例

HTTP请求报文

POST /oauth/token HTTP/1.1
Host:api2.hik-cloud.com

client_id=a4f********b324&client_secret=0b********df59e68&grant_type=client_credentials&scope=app

返回示例

{
"access_token": "62c54b72-c85f-4a4e-8fd0-6941744d0af7",
"token_type":"bearer",
"expires_in": 43199,
"scope":"app"
}

2.区域管理

创建区域

功能描述

提供租户创建区域功能，目的是为了管理门店分组

注：根区域为海康云眸平台默认生成，需要客户提供根区域ID，海康云眸平台研发人员进行初始化

接口定义

接口地址

/v1/customization/extern/areas

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externAreaId区域IDString64是
areaName区域名称String32是
externParentId上级区域IDString64是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明：

属性名称属性描述类型长度是否必填
areaId云眸区域IDString32是
externAreaId区域IDString64是

实现示例

HTTP请求报文

POST /v1/customization/extern/areas HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
Content-Type: application/json

{
"externAreaId":"c738886e8ae948c738886e8ae9486db266b4b3fbbac38d6db266b4b3fbbac38d",
"areaName":"测试区域",
"externParentId":"db266b4b486db266b4b3fbc738886e8ae9bac38dc738886e8ae94863fbbac38d"
}

返回示例

{
"code": 200,
"message": "操作成功",
"data": {
"areaId": "86db266b4b3fbbac38dc738886e8ae94",
"externAreaId":"c738886e8ae948c738886e8ae9486db266b4b3fbbac38d6db266b4b3fbbac38d"
}
}

更新区域

功能描述

更新区域

接口定义

接口地址

/v1/customization/extern/areas/{externAreaId}

请求方式：PUT

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
areaName区域名称String32是
externAreaId区域IDString64是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

PUT /v1/customization/extern/areas/bd48eeb0bd48eeb07da4459b84a294abaa18399f7da4459b84a294abaa18399f HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 5d6384a9-5d56-453a-b7d9-88770c14d36d
Content-Type: application/json

{
"areaName":"测试修改"
}

返回示例

{
"code": "200",
"message": "操作成功"
}

删除区域

功能描述

删除区域

接口定义

接口地址

/v1/customization/extern/areas/{externAreaId}

请求方式：DELETE

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externAreaId区域IDString64是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

DELETE /v1/customization/extern/areas/bd48eeb0bd48eeb07da4459b84a294abaa18399f7da4459b84a294abaa18399f HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

返回示例

{
"code": "200",
"message": "操作成功"
}

获取区域列表

功能描述

异步获取下一级区域列表功能

接口定义

接口地址

/v1/customization/extern/areas

请求方式：GET

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externAreaId区域ID，不传则查询租户根区域String64否

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
externAreaId区域IDString64是
areaName区域名称String16是
externParentId上级区域IDString64是
path区域路径String是

实现示例

HTTP请求报文

GET /v1/customization/extern/areas?externAreaId=0965ed6a0965ed6ad3e24103b1353eb0dced7976d3e24103b1353eb0dced7976 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

返回示例

{
"code": "200",
"message": "操作成功",
"data": [
{
"externAreaId": "e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2",
"areaName": "二级区域01",
"externParentId": "0965ed6a0965ed6ad3e24103b1353eb0dced7976d3e24103b1353eb0dced7976"，
"path": "/一级区域/二级区域01/"
},
{
"externAreaId": "f4402d9f9f4402d9f91ae49268ad0de400baf6dfa1ae49268ad0de400baf6dfa",
"areaName": "二级区域02",
"parentId": "0965ed6a0965ed6ad3e24103b1353eb0dced7976d3e24103b1353eb0dced7976"，
"path": "/一级区域/二级区域02/"

}
]
}

3.门店管理

创建门店

功能描述

创建门店

接口定义

接口地址

/v1/customization/extern/stores

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externStoreId门店IDString64是
storeName门店名称String32是
externAreaId归属区域IDString64是
addressProvince归属省（参考2.8.1查询省市区信息接口）String64是
addressCity归属市（参考2.8.1查询省市区信息接口）String64是
addressCounty归属区（参考2.8.1查询省市区信息接口）String64是（市下无区县可不填）
addressDetail详细地址String128否
storeMeasure门店面积（精确到小数点后一位）String8否
storeRemark备注String128否
storeTel门店电话String16否
storeNo门店编号String16否
storeLng门店经度Double15,6是
storeLat门店纬度Double15,6是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明：

属性名称属性描述类型长度是否必填
storeId云眸门店IDString32是
externStoreId门店IDString64是

实现示例

HTTP请求报文

POST /v1/customization/extern/stores HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
Content-Type: application/json

{
"externStoreId":"c1bb1d613bc94c2c1bb1d613bc94c28ab31bff96aaed1398ab31bff96aaed139"
"storeName": "测试门店",
"externAreaId": "bff96aaed139c1bb1d613bc94c28ab31c1bb1d613bc94c28ab31bff96aaed139",
"addressProvince": "150000",
"addressCity": "150500",
"addressCounty": "150523",
"addressDetail": "开鲁镇",
"storeNo": "zk001",
"storeMeasure": "10.2",
"storeRemark": "第一个门店",
"storeTel": "0475-6832332",
"storeLng": "20.1992",
"storeLat": "30.19926"
}

返回示例

{
"code": 200,
"message": "操作成功",
"data": {
"storeId": "c1bb1d613bc94c28ab31bff96aaed139",
"externStoreId":"c1bb1d613bc94c2c1bb1d613bc94c28ab31bff96aaed1398ab31bff96aaed139"
}
}

批量删除门店

功能描述

批量删除门店

接口定义

接口地址

/v1/customization/extern/stores/delete

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externStoreIds门店ID列表Array[String]是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

POST /v1/customization/extern/stores/delete HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
Content-Type: application/json

{
"externStoreIds": [
"a0d949a0d9490820dc4c728bf60d7cd6ab950d0820dc4c728bf60d7cd6ab950d"
]
}

返回示例

{
"code": "200",
"message": "操作成功"
}

获取区域下的门店列表

功能描述

获取区域下的门店列表

接口定义

接口地址

/v1/customization/extern/stores

请求方式：GET

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externAreaId区域IDString64是
pageNo当前页码（大于0）Integer8是
pageSize每页记录数，最大为999Integer3是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
pageNo当前页数Integer8否
pageSize每页数据记录数Integer3否
total查询数据记录总数Integer8否
totalPage总共页数Integer8否
hasNextPage是否有下一页Boolean否
hasPreviousPage是否有上一页Boolean否
isfirstPage是否首页Boolean否
islastPage是否尾页Boolean否
rows对象列表，若未查到记录，空集合List否

rows对象说明

属性名称属性描述类型长度是否必填
externStoreId门店IDString64是
storeName门店名String16是
externAreaId归属区域String64是
path门店路径String是
addressPcc门店完整地址String64否
addressProvince归属省String64是
addressProvinceName归属省名称String64是
addressCity归属市String64是
addressCityName归属市名称String64是
addressCounty归属区String64是
addressCountyName归属区名称String64是
addressDetail详细地址String255否
storeTel门店电话String16否
storeNo门店编号String16否
storeLng门店经度Double15,6是
storeLat门店纬度Double15,6是
storeRemark门店描述String128否
storeMeasure门店面积（精确到小数点后一位）String8否

实现示例

HTTP请求报文

GET /v1/customization/extern/stores?areaId=b2e61e04d1b2e61e04d1e241c6a2467575cb3d0fd2e241c6a2467575cb3d0fd2&pageNo=1&pageSize=11 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

返回示例

{
"code": "200",
"message": "操作成功",
"data": {
"pageNo": 1,
"pageSize": 10,
"total": 1,
"totalPage": 1,
"hasNextPage": false,
"hasPreviousPage": false,
"isfirstPage": true,
"islastPage": true,
"rows": [
{
"externStoreId": "2111111111111111111111111111111111111111111111111111111111111113",
"storeName": "门店004",
"externAreaId": "b2e61e04d1b2e61e04d1e241c6a2467575cb3d0fd2e241c6a2467575cb3d0fd2",
"path": "/测试/二级区域4/三级区域4-1/",
"addressProvince": "460000",
"provinceName": "海南省",
"addressCity": "460200",
"cityName": "三亚市",
"addressCounty": "460203",
"countyName": "吉阳区",
"addressDetail": "开鲁镇",
"addressPcc": "海南省三亚市吉阳区开鲁镇",
"storeMeasure": "10.2",
"storeRemark": "益丰门店002",
"storeLng": 109.611223,
"storeLat": 49.26,
"storeNo": "sss004",
"storeTel": "0475-6832332"
}
]
}
}

获取门店详情

功能描述

获取单个门店的详细信息

接口定义

接口地址

/v1/customization/extern/stores/{externStoreId}

请求方式：GET

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externStoreId门店IDString64是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
externStoreId门店IDString64是
storeName门店名String16是
externAreaId所属区域IDString64是
path门店路径String是
addressPcc门店完整地址String64否
addressProvince归属省String64是
addressProvinceName归属省名称String64是
addressCity归属市String64是
addressCityName归属市名称String64是
addressCounty归属区String64是
addressCountyName归属区名称String64是
addressDetail详细地址String255否
storeMeasure门店面积（精确到小数点后一位）String16否
storeTel门店电话String16否
storeNo门店编号String16否
storeLng门店经度Double15,6否
storeLat门店纬度Double15,6否
storeRemark门店描述String128否

实现示例

HTTP请求报文

GET /v1/customization/extern/stores/b2e61e04d1b2e61e04d1e241c6a2467575cb3d0fd2e241c6a2467575cb3d0fd2 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

返回示例

{
"code": 200,
"message": "操作成功",
"data": {
"externStoreId": "b2e61e04d1b2e61e04d1e241c6a2467575cb3d0fd2e241c6a2467575cb3d0fd2",
"storeName": "开发门店",
"externAreaId": "e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2",
"path": "/海康云眸/00A开发区域M1/",
"addressProvince": "330000",
"provinceName": "浙江省",
"addressCity": "330100",
"cityName": "杭州市",
"addressCounty": "330108",
"countyName": "滨江区",
"addressDetail": "阡陌路556号海康威视3期",
"addressPcc": "浙江省杭州市滨江区阡陌路556号海康威视3期",
"storeMeasure": "",
"storeRemark": "",
"storeLng": 120.229992,
"storeLat": 30.217058,
"storeNo": "",
"storeTel": ""
}
}

更新门店

功能描述

更新单个门店信息（覆盖更新）

接口定义

接口地址

/v1/customization/extern/stores/{externStoreId}

请求方式：PUT

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externStoreId门店IDString64是
storeName门店名称String16是
externAreaId归属区域IDString64是
addressProvince归属省（参考2.8.1查询省市区信息接口）String64是
addressCity归属市（参考2.8.1查询省市区信息接口）String64是
addressCounty归属区（参考2.8.1查询省市区信息接口）String64是（市下无区县可不填）
addressDetail详细地址String128否
storeMeasure门店面积（精确到小数点后一位）String8否
storeRemark备注String128否
storeTel门店电话String16否
storeNo门店编号String16否
storeLng门店经度Double15,6是
storeLat门店纬度Double15,6是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

实现示例

HTTP请求报文

PUT /v1/customization/extern/stores/80a9b820e0b6ead4d264380a9b820ee58c6827639e58c68276396430b6ead4d2 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
Content-Type: application/json

{
"storeName": "开发门店",
"externAreaId": "e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2",
"addressProvince": "330000",
"provinceName": "浙江省",
"addressCity": "330100",
"cityName": "杭州市",
"addressCounty": "330108",
"countyName": "滨江区",
"addressDetail": "阡陌路556号海康威视3期",
"storeMeasure": "10.2",
"storeRemark": "xxxxxxxxxxgggggg",
"storeLng": 120.229992,
"storeLat": 30.217058,
"storeNo": "xxxxxxxggggg",
"storeTel": ""
}

返回示例

{
"code": 200,
"message": "操作成功"
}

4.部门组织管理

创建组织

功能描述

创建部门组织

注：根组织为海康云眸平台默认生成，需要客户提供根组织ID，海康云眸平台研发人员进行初始化

接口定义

接口地址

/v1/auth/extern/orgs

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externOrgId组织IDString64是
orgName组织名称String16是
externParentId上级组织IDString64是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明：

属性名称属性描述类型长度是否必填
orgId云眸组织IDString32是
externOrgId组织IDString64是

实现示例

HTTP请求报文

POST /v1/auth/extern/orgs HTTP/1.1
Host: api2.hik-cloud.com
Content-Type: application/json
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

{
"orgName":"测试组织",
"externOrgId":"e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2",
"externParentId":"80a9b820e0b6ead4d264380a9b820e0b6ead4d2e58c6827639e58c6827639643"
}

返回示例

{
"code": 200,
"message": "操作成功",
"data": {
"orgId": "c1bb1d613bc94c28ab31bff96aaed139",
"externOrgId": "e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2"
}
}

更新组织

功能描述

更新部门组织

接口定义

接口地址

/v1/auth/extern/orgs/{externOrgId}

请求方式：PUT

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
orgName组织名称String16是
externOrgId组织IDString64是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

PUT /v1/auth/extern/orgs/e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2 HTTP/1.1
Host: api2.hik-cloud.com
Content-Type: application/json
Authorization: bearer 5d6384a9-5d56-453a-b7d9-88770c14d36d

{
"orgName":"测试修改"
}

返回示例

{
"code": "200",
"message": "操作成功"
}

删除组织

功能描述

删除部门组织

接口定义

接口地址

/v1/auth/extern/orgs/{externOrgId}

请求方式：DELETE

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externOrgId组织IDString64是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

DELETE /v1/auth/extern/orgs/e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

返回示例

{
"code": "200",
"message": "操作成功"
}

获取组织列表

功能描述

异步获取下一级组织列表功能

接口定义

接口地址

/v1/auth/extern/orgs

请求方式：GET

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externOrgId组织ID，不传则查询根组织String64否

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
externOrgId组织IDString64是
orgName组织名称String16是
externParentId上级组织IDString64是
path组织路径String是

实现示例

HTTP请求报文

GET /v1/auth/extern/orgs?externOrgId=e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 5d6384a9-5d56-453a-b7d9-88770c14d36d

返回示例

{
"code": "200",
"message": "操作成功",
"data": [
{
"externOrgId": "ad4d264380a9b820e0b6ead4d2e58c6827639e58c682763964380a9b820e0b6e",
"orgName": "二级组织01",
"externParentId": "xxe58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2xx"，
"path": "/一级组织/二级组织01/"
},
{
"externOrgId": "ad4d264380a9b820e0b6ead4d2e58c6827639e58c682763964380a9b820e0b6e",
"orgName": "二级组织01",
"externParentId": "e58c6827639e58c682763964380a9b820e0b6ead4d264380a9b820e0b6ead4d2"，
"path": "/一级组织/二级组织02/"
}
]
}

5.用户管理

创建用户

功能描述

该接口用于创建云眸用户。支持传入账号、密码及手机号，且账号、手机号在整个云眸系统内（不限于本租户/企业）不可重复。

通过接口创建用户，一个账号只允许在一个租户(企业)中存在

注：管理员为海康云眸平台默认生成，需要客户提供管理员ID，海康云眸平台研发人员进行初始化

接口定义

接口地址

/v1/auth/extern/users

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填备注
externUserId用户IDString64是用户ID
userAccount账号String32是格式要求：大小写字母、数字和@._(不能为纯数字), 最大32位
password密码String64是密码明文限制:8-16位字符，需包含数字和字母，特殊字符随意，加密后传输，加密方式采用sha256，加密后长度为64
userNo用户编号String16否格式要求:大小写字母、数字和.
userName用户姓名String32是格式要求：大小写字母、数字和中文
gender性别Integer1是性别:1-男,0-女
externOrgId归属组织 IDString64是归属组织ID
phoneNumber手机号String11是格式要求：以1开头的第二位不能是0、1、2的11位数字
email邮箱地址String100否
description备注String128否
listPositionId关联的职位 IDArray[String]是
relatedExternOrgIds管理的组织 IDArray[String]否
relatedExternAreaIds管理的区域 IDArray[String]否
relatedExternStoreIds管理的门店 IDArray[String]否

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码Integer10是
message返回消息String64是
data节点对象Object是

data字段说明：

属性名称属性描述类型长度是否必填
userId云眸用户IDString32是
externUserId用户IDString64是

实现示例

HTTP请求报文

POST /v1/auth/extern/users HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
Content-Type: application/json

{ "externUserId":"1111111111111111111111111111111111111111111111111111111111111110",
"userAccount": "account001",
"password": "ce54ab9e6b095cc4c579c07d6c22c8892db86d2fe1465b7ad08ff8427df84353",
"userNo":"user001",
"userName":"user001",
"gender":"1",
"externOrgId":"27bb3bbd075d27bb3bbd075d4f64abbdf501c023a2104f64abbdf501c023a210",
"phoneNumber":"18800142558",
"email":"18800142558@qq.com",
"description":"我是描述",
"listPositionId":[
"fc9ae86ffcce43a9bf24e15c4b4f98eb"
],
"relatedExternOrgIds":[
"8113e745998113e74599f440718acdd04d95add391f440718acdd04d95add391"
],
"relatedExternAreaIds ":[
"c657d026c3fc657d026c3ff4b2ba2760c912ff35165f4b2ba2760c912ff35165"
],
"relatedExternStoreIds ":[
"8113e74598113e74599f440718acdd04d95add3919f440718acdd04d95add391"
]
}

返回示例

{
"code": 200,
"message": "操作成功",
"data": {
"userId": "a657d026c3ec657d026c3ff4b5ba2760",
"externUserId": "1111111111111111111111111111111111111111111111111111111111111110"
}
}

更新用户

功能描述

该接口用于更新单个云眸用户

接口定义

接口地址

/v1/auth/extern/users/{externUserId}

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填备注
externUserId用户IDString64是用户ID
userNo用户编号String16否格式要求:大小写字母、数字和.
userName用户姓名String32是格式要求：大小写字母、数字和中文
gender性别Integer1是
externOrgId归属组织IDString64是
phoneNumber手机号String11是格式要求：以1开头的第二位不能是0、1、2的11位数字
email邮箱地址String100否
description备注String128否
listPositionId关联的职位IDArray是
relatedExternOrgIds管理的组织IDArray否
relatedExternAreaIds管理的区域IDArray否
relatedExternStoreIds管理的门店IDArray否

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

POST /v1/auth/extern/users/8113e74599f48113e74599f440718acdd04d95add39140718acdd04d95add391 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
Content-Type: application/json

{
"userNo": "xxxx",
"userName": "测试1031",
"gender": "1",
"externOrgId": "xxxxxxx",
"phoneNumber": "xxxxxx",
"email": "xxxxxx@123.com",
"description": "我是描述",
"listPositionId": [
"xxxxxxx"
],
"relatedExternOrgIds": [
"8113e74598113e74599f440718acdd04d95add3919f440718acdd04d95add391"
],
"relatedExternAreaIds ": [
"c657d026c657d026c3ff4b2ba2760c912ff35165c3ff4b2ba2760c912ff35165"
],
"relatedExternStoreIds ": [
"7557e7557e02fe3f8db2ba8560c912ff351ed02fe3f8db2ba8560c912ff351ed"
]
}

返回示例

{
"code": "200",
"message": "操作成功"
}

批量删除用户

功能描述

该接口用于批量删除云眸用户。为兼容老版本，若该账号只关联一个租户(企业)，则在用户删除后，账号也被删除。

接口定义

接口地址

/v1/auth/extern/users/delete

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externUserIds用户ID列表Array[String]最大50是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

POST /v1/auth/users/delete HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
Content-Type: application/json

{
"externUserIds": [
"7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed"
]
}

返回示例

{
"code": "200",
"message": "操作成功"
}

获取组织下用户列表

功能描述

该接口用于查询组织下用户列表，包括直属的用户与子组织下用户。

接口定义

接口地址

/v1/auth/extern/users

请求方式：GET

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
externOrgId组织IDString64是
pageNo当前页码（大于0）Integer8是
pageSize每页记录数，最大为999Integer3是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
pageNo当前页数Integer8否
pageSize每页数据记录数Integer3否
total查询数据记录总数Integer8否
totalPage总共页数Integer8否
hasNextPage是否有下一页Boolean否
hasPreviousPage是否有上一页Boolean否
isfirstPage是否首页Boolean否
islastPage是否尾页Boolean否
rows对象列表，若未查到记录，空集合List否

rows对象说明

属性名称属性描述类型长度是否必填
externUserId用户IDString64是
userName用户姓名String32是
path归属组织路径String是
roleIds关联职位IDArray是
positionNames职位名称String是
gender性别Integer1是
email邮箱地址String100否
phoneNumber联系方式String11是
description备注String128否
forbiddenStatus禁用状态Boolean是
userAccount用户名String32是
userNo用户编号String16否
externOrgId归属组织IDString64是

实现示例

HTTP请求报文

GET /v1/auth/users?pageNo=1&pageSize=11&externOrgId=7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

返回示例

{
"code": "200",
"message": "操作成功",
"data": {
"pageNo": 1,
"pageSize": 10,
"total": 1,
"totalPage": 1,
"hasNextPage": false,
"hasPreviousPage": false,
"isfirstPage": true,
"islastPage": true,
"rows": [
{
"externUserId": "7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed",
"userName": "xxxx",
"roleIds": [
"xxxxx"
],
"positionNames": "xxxxxx",
"path": "xxxx/1/12",
"gender": 1,
"email": "",
"phoneNumber": "xxxxxxxx",
"description": "",
"forbiddenStatus": false,
"userAccount": "xxxxx",
"userNo": "xxxxx",
"externOrgId": "7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed"
},
{
"externUserId": "7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed",
"userName": "xxxxxx",
"roleIds": [
"xxxxx"
],
"positionNames": "xxxxx",
"path": "xxxxxx/测试组织12",
"gender": 1,
"email": "test@hikvision.com",
"phoneNumber": "xxxxx",
"description": "用户测试",
"forbiddenStatus": false,
"userAccount": "xxxx",
"userNo": null,
"externOrgId": "7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed"
}
]
}
}

获取用户职位列表

功能描述

获取用户的职位列表

接口定义

接口地址

/v1/customization/positions

请求方式：GET

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
pageNo当前页码（大于0）Integer8是
pageSize每页记录数，最大为999Integer3是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
pageNo当前页数Integer8否
pageSize每页数据记录数Integer3否
total查询数据记录总数Integer8否
totalPage总共页数Integer8否
hasNextPage是否有下一页Boolean否
hasPreviousPage是否有上一页Boolean否
isfirstPage是否首页Boolean否
islastPage是否尾页Boolean否
rows对象列表，若未查到记录，空集合List否

rows对象说明

属性名称属性描述类型长度是否必填
positionId职位IDString32否
positionName职位名称String20否
menuNames菜单名称String否
positionRemark备注String128否

实现示例

HTTP请求报文

GET /v1/customization/positions?pageNo=1& pageSize=11 HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632

返回示例

{
"code": "200",
"message": "操作成功",
"data": {
"pageNo": 1,
"pageSize": 10,
"total": 1,
"totalPage": 1,
"hasNextPage": false,
"hasPreviousPage": false,
"isfirstPage": true,
"islastPage": true,
"roles": [
{
"positionId": "6d10b7dd52ac49a18ad7852e59661636",
"positionName": "巡查员",
"menuNames": "运维管理(设备管理、设备查看、设备离线报警、设备上线报警、标签管理)",
"positionRemark": "职位描述"
}
]
}
}

绑定第三方职位列表

功能描述

获取用户的职位列表

接口定义

接口地址

/v1/auth/role/actions/bindThirdRole

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填
thridRoleId第三方角色String32是
positionId云眸角色Integer32是

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
pageNo当前页数Integer8否

实现示例

HTTP请求报文

POST /v1/auth/role/actions/bindThirdRole HTTP/1.1
Host: api2.hik-cloud.com
Authorization: bearer 31e89b7f-144b-49e3-97b2-272d379e3632
{
"thridRoleId": "xxxxxxxxxxxx2222",
"positionId": "xxxx222222222222222"
}

返回示例

{
"code": "200",
"message": "操作成功",
"data": {
"pageNo": 1,
"pageSize": 10,
"total": 1,
"totalPage": 1,
"hasNextPage": false,
"hasPreviousPage": false,
"isfirstPage": true,
"islastPage": true,
"roles": [
{
"positionId": "6d10b7dd52ac49a18ad7852e59661636",
"positionName": "巡查员",
"menuNames": "运维管理(设备管理、设备查看、设备离线报警、设备上线报警、标签管理)",
"positionRemark": "职位描述"
}
]
}
}

获取单个用户详情

功能描述

该接口用于，根据手机号或账号，查询单个用户信息。

接口定义

接口地址

/v1/auth/extern/users/get

请求方式：GET

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填备注
phoneNumber手机号String11否手机号或账号不能同时为空
userAccount账号String32否

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是
data节点对象Object是

data字段说明

属性名称属性描述类型长度是否必填
externUserId用户IDString64是
userName用户姓名String32是
externOrgs组织信息Array[Object]是
roleIds关联职位IDArray是
positionNames职位名称String是
gender性别Integer1是
email邮箱地址String100否
phoneNumber联系方式String11是
description备注String128否
forbiddenStatus禁用状态Boolean是
userAccount用户名String32是
userNo用户编号String16否
relatedExternAreaIds管理区域Array[String]
relatedExternStoreIds管理门店Array[String]

organizations对象说明

属性名称属性描述类型长度是否必填
externOrgId组织idString64是
orgPathName组织路径String是

实现示例

HTTP请求报文

GET /v1/auth/extern/users/get?phoneNumber=18888888888 HTTP/1.1
HTTP: api2.hik-cloud.com
Content-Type: application/json; charset=utf-8
Authorization: bearer 62c54b72-c85f-4a4e-8fd0-6941744d0af7

返回示例

{
"code": 200,
"message": "操作成功",
"data": {
"externUserId": "7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed",
"userName": "wld",
"externOrgs": [
{
"externOrgId": "7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed",
"orgPathName": "/wld门禁"
}
],
"roleIds": [],
"positionNames": "",
"gender": 0,
"email": "11111233@qq.com",
"phoneNumber": “18888888888”,
"description": null,
"forbiddenStatus": false,
"userAccount": "wld0305",
"userNo": null
}
}

启用/禁用用户

功能描述

该接口用于启用/禁用云眸用户

接口定义

接口地址

/v1/auth/extern/users/status/update

请求方式：POST

接口参数

输入参数

表1.输入参数

属性名称属性描述类型长度是否必填备注
externUserId用户IDString64是
ban是否禁用Boolean是true为禁用，false为启用

输出参数

表2.输出参数

属性名称属性描述类型长度是否必填
code返回码String10是
message返回消息String64是

实现示例

HTTP请求报文

POST /v1/auth/extern/users/status/update HTTP/1.1
HTTP: api2.hik-cloud.com
Content-Type: application/json; charset=utf-8
Authorization: bearer 62c54b72-c85f-4a4e-8fd0-6941744d0af7
{
"externUserId": "7557e02fe3f8db2ba8560c557e02fe3f8db2ba912ff351ed7557e02fe3f8db2ba8560c912ff351ed",
"ban": false
}

返回示例

{
"code": "200",
"message": "操作成功"
}
行者man
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
java http 表单_java中的http请求的封装（GET、POST、form表单形式）
weixin_35315373的博客
02-12 556
packagecom.mobile.utils;importcom.alibaba.fastjson.JSONObject;importorg.apache.log4j.Logger;import java.io.*;importjava.net.HttpURLConnection;importjava.net.MalformedURLException;importjava.net.URL;im...
android 海康云眸SDK简单使用
liuye066的专栏
07-08 6852
SDK集成步骤： 1. 将从官网https://www.hik-cloud.com/poseidon/index.html#/download 上下载的HikCloudOpenSDK-1.0.3.aar放到libs目录下，并在build.gradle中添加： android{ defaultConfig { ... ndk { abiFilters "armeabi-v7a", "arm64-v8a" } } .
萤石开放平台-定时获取AccessToken
JackGong1999的博客
04-27 3712
毕业设计中，有一项海康威视摄像头实时监控的功能，需要去萤石开放平台获取AppKey、Secret和AccessToken。但是有一个问题，获取到的AccessToken只有7天有效期。每隔7天就要获取一次token。项目发布后不可能通过手动去获取，而是要通过代码自动去获取。因此，去查找萤石开放平台的官方文档，通过接口进行调用。 萤石开放平台文档 因为项目采用的是ssm框架，因此在这里，使用springmvc配置定时执行任务，定期通过接口获取AccessToken，然后修改MySQL数据库中的数据，来达到
海康威视接口调用
热门推荐
Lyq2017901206的博客
10-21 1万+
综合安防管理平台提供了OpenAPI安全认证库（Java）快速实现接口调用。 1.设置认证信息，设置ArtemisConfig的host，appKey，appSecret。 2.设置接口URL。 3.设置接口入参。 4.接口调用，调用doPostStringArtemis方法（该方法内部实现了登入认证逻辑），传入接口URL，接口入参，数据提交类型等信息，完成接口调用。 ​
海康SDK方式对接摄像头
Temp_1998_H的博客
05-31 6712
1知识相关: OpenAPI:对外开放的接口 Http Methodhttp:请求的方法，常用的方法有GET/POST/PUT/DELETE等请求 Path:http请求路径，指域名/IP（端口号）之后的部分，如请求地址为"www.example.com/artemis/api"，则path指"/artemis/api" appKey\appSecret:一对appKey/appSecret用于标识一个调用方，appSecret作为密钥参与签名计算 AK:AK(Access Key I
Qt无标题窗口
05-21
在本文中，我们将深入探讨如何使用Qt框架创建一个无标题窗口，这在界面设计和自定义标题栏美化中非常有用。我们将关注`framelesswidget.cpp`、`main.cpp`、`framelesswidget.h`等核心文件，理解它们在实现无标题窗口...
VC去掉'无标题'字样的方法.zip
11-21
在使用Visual C++进行编程时，我们经常会在创建新的窗口或者对话框时默认看到标题栏显示为“无标题”。这可能会对用户界面的美观性和专业性造成一定的影响。本资料包提供了一种方法来帮助开发者去掉这个“无标题”...
visual c++取掉对话框窗口的 -无标题 字样的方法
08-04
在Visual C++编程环境中，创建窗口应用程序时，默认情况下，窗口标题栏可能会显示“-无标题”字样，这通常是由于没有正确设置窗口类或没有自定义窗口标题所导致的。要解决这个问题，我们需要深入理解Windows API中的...
c#实现无标题栏窗口的拖动
09-05
本篇文章将详细讲解如何在C#中实现这种无标题栏窗口的拖动以及其他基本操作。 首先，为了实现无标题栏窗口的拖动，我们需要处理窗体的鼠标事件。窗体的`FormBorderStyle`属性应设置为`None`，这会去除窗体的边框和...
delphi 无标题调整大小
11-26
在Delphi编程环境中，"无标题调整大小"通常是指创建没有标准标题栏的窗口，并允许用户通过拖动边界来调整其大小。这种设计通常用于自定义界面或创建无边框的对话框。以下是对这个主题的详细解释： 一、创建无标题...
海康官方 API
09-11
海康 API CHCNetSDK 播放库 网络库
海康OpenAPI安全认证库（C#）-V1.0.1_20200811140815.rar
09-22
海康OpenAPI安全认证库（C#），OpenAPI安全认证库封装了HTTP/HTTPS的POST与GET方法，提供C#调OpenAPIHTTP接口统一 的入口。OpenAPI安全认证库屏蔽了OpenAPIHTTP接口签名细节，降低C#对接OpenAPI的复杂度，使用 方只需引入OpenAPI安全认证库（C#）即可方便快速的实现HTTP通信。 提供源代码，已使用Visual Studio 2015以及.Net4.5.2基于Any CPU平台编译出HttpUtillib.dll，位于bin 目录中，兼容32/64位程序对接。
关于海康摄像头的摘要认证
y673533511的博客
03-11 9340
最近在做一个项目时候要用到摄像头人脸抓拍，人脸识别等功能，原本使用海康的SDK就可以解决的，但是我们项目是在arm平台下开发的，而海康的SDK不支持arm平台，无奈联系的海康的技术支持，他们提供的了一种基于海康私有ISAPI 协议，通过HTTP进行摘要认证。 什么是摘要认证？ 简单的说就是你要登录某个网站，网站会让你输入用户名密码才才能进行正常的操作，这首先浏览器会首先发出一个请求，然后服务器传...
如何获取access_token
tang_tss的博客
04-13 5951
access_token是公众号的全局唯一接口调用凭据，公众号调用各接口时都需使用access_token。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。access_token的有效期目前为2个小时，需定时刷新，重复获取将导致上次获取的access_token失效。公众平台的API调用所需的access_token的使用及生成方式说明：1、建议公众号开发者使用...
C# 海康威视平台API接入 和网页摄像头部署
最新发布
qq_44695769的博客
10-26 5140
最近有个需求是将海康的摄像头视频画面传到我们平台上，作为一个全干工程师，网页后端都要我来做。
海康威视摄像头接海康云眸备忘录
qq_39709275的博客
12-07 4099
背景 鉴于海康威视的摄像头说明文档解释不够细致，海康云眸系统还不够完善，形成了一些需要自行探索和求助海康威视技术人员才能解决的问题区域。 摄像头无验证码 当摄像头机身不带设备验证码时，要把摄像头连到电脑上，在网络高级配置界面中的平台接入选择萤石云，自行设置。设置完成后即可用设置好的验证码添加摄像头。 海康云眸无法播放视频 海康云眸平台暂时对某些种类的摄像头不兼容，添加之后无法播放视频，这个时候要电话联系客服专门解决，电话：4008005998. ...
第三方研发如何对接海康综合安防管理平台进行二次开发？
qq_1059136269
01-23 1万+
目前海康有：海康威视智能应用平台（Infovision IoT）和综合安防管理平台（iSecure Center）两套不同构架的平台。而本文适合第三方研发对接海康综合安防管理平台（iSecure Center）进行开发的相关说明，更多开发文档请移驾海康开放平台查阅：Hikvision AI Cloud 开放平台。 下面就快速对接综合安防管理平台（iSecure Center）开发进行一些简要说明，更详细的文档说明请移步官网查阅。 一、环境准备 对接前需要先部署海康威视综合安防管理平台 iSecure
IOTOS物联中台对接海康安防平台（iSecure Center）门禁系统
IOTOS的博客
04-22 5155
IOTOS物联中台海康门禁机（接口）驱动开发实例前言目的适用范围使用示例代码示例代码说明初始化采集循环进程请求门禁数据点代码(设备)数据点运行结果 前言 IOTOS对接海康门禁机 目的 获取门禁机的开关状态 适用范围 所有海康门禁机的硬件设备、IOTOS采集程序 使用示例 代码示例 #!coding:utf8 import json import sys import threading sys.path.append("..") from driver import * import logging i
设置无标题 android
05-02
在Android应用中，设置无标题是一种简洁和美观的设计方式，可以为用户提供更流畅的使用体验。以下是一些实现设置无标题的方法： 1. 在Android的Manifest文件中，找到对应Activity的标签，并添加”android:theme="@android:style/Theme.NoTitleBar"“属性。这样可以通过Android自带的主题去掉标题栏。 2. 使用自定义的主题，可以在样式表中添加以下代码： <style name="AppTheme" parent="Theme.AppCompat.NoActionBar"> <!-- ...其他样式... --> </style> 这种方式可以通过设置主题去除ActionBar和标题栏，同时保留其他布局元素。 3. 去掉代码中的setTitle()方法，这是一种最简单的方法，通过不设置Activity的标题来实现无标题。 以上就是三种常见的实现Android无标题的方式，开发者可以根据实际需求进行选择。值得注意的是，去除标题栏可能会影响用户的导航体验，因此在设计上需要考虑周全。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值