传统门禁云云对接

更新时间:2018-12-29 16:35:11

公共字段

以下参数通过登录信息中提取,不需要每次调用的时候传递

参数名称 参数
用户ID identityId
租户ID tenantId
登录用户租户ID identityTenantId
appKey appKey
资源隔离ID isolationId
环境(开发,线上) env
调用方Ip clientIp
语言 language
地理位置、ip locale
通过智慧人居服务以下两个接口获取:* 房屋列表:/homelink/house/list


* 房屋详情:/homelink/house/detail/get

| scopeId |

门禁云云对接(不支持家人功能)

1人跟空间权限的同步:

path 版本 描述 是否需要登录
/campuslink/entranceGuard/isv/addSpacePermission 0.0.5 isv同步人和空间权限,每次最多100条数据

1.1 请求参数

参数字段名 类型 是否必须 参数说明
scopeId String 园区ID,也就是topSpaceId
spacePermissions JSON [{ "id":2,"appkey":"25038554", "accountId":"15090","accountType":"openId","spaceCode":"f4a8fe8b64f148c3bb7e2db3e1fd94ec","spaceName":"1栋1单元" }]

1.2 返回参数

1.3 示例

  • 请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "0.0.5",
        "iotToken": ""
    },
    "params": {
        "scopeId": "cfb5681cf6324bfa867bf5279cdc9976",
        "appkey": "25038554",
        "accountId": "15090",
        "accountType":"openId",
        "spaceCode":"f4a8fe8b64f148c3bb7e2db3e1fd94ec",
        "spaceName":"1栋1单元"
    }
}
  • 返回实例
{
    "code": 200,
    "message": "success"
}

2. 门禁进出事件上报接口:

path 版本 描述 是否需要登录
/campuslink/entranceGuard/isv/reportGuardEvent 0.0.5 门禁进出事件上报接口

2.1 请求参数

参数字段名 类型 是否必须 参数说明
scopeId String 园区ID,也就是topSpaceId
recordId String isv的事件记录id
appkey String 注册OA账号的appkey
accountId String 三方需要同步OA账号的id
accountType String 同步账号的类型, 目前支持:openId, phoneNum
mediaId String 进出门禁的介质id
mediaType String 进出门禁的介质类型,比如:card,face
spaceCode String 用户可以访问的isv空间编码,只需要业主对应单元的空间编码即可
spaceName String 户可以访问的isv空间名称
eventTime date 事件发生时间
eventTye String 事件类型;
进入门禁事件:BIZ_EV_ENTRANCEGUARD_IN
出门禁事件:BIZ_EV_ENTRANCEGUARD_OUT

2.2 返回参数

2.3 示例

  • 请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "0.0.5",
        "iotToken": ""
    },
    "params": {
        "scopeId": "aaaaaaaaaaaa4bfa867bf5279cdc9976",
        "recordId": "150901",
        "appkey": "25038554",
        "accountId": "15090",
       "accountType":"openId",
       "spaceCode":"f4a8fe8b64f148c3bb7e2db3e1fd94ec",
       "spaceName":"1栋1单元",
        "mediaId": "6324bfa867bf5279cdc9976",
        "mediaType": "card",
        "eventTime": "25038554",
        "eventTye": "BIZ_EV_ENTRANCEGUARD_IN"
    }
}
  • 返回实例
{
    "code": 200,
    "message": "success"
}

3 查询所拥有权限的空间

path 版本 描述 是否需要登录
/campuslink/entranceGuard/listPubPermissionSpaces 0.0.5 查询所拥有权限空间列表的接口,用于场景面板设置场景用

3.1 请求参数

参数字段名 类型 是否必须 参数说明
scopeId String 园区ID,也就是topSpaceId

3.2 返回参数

3.3 示例

  • 请求实例
{
    "id": "1509086454180",
    "version": "1.0",
    "request": {
        "apiVer": "0.0.5",
        "iotToken": "token"
    },
    "params": {
        "scopeId": "aaaaaaaaaaaa4bfa867bf5279cdc9976"
    }
}
  • 返回实例
{
    "code": 200,
    "data": [
        {
            "spaceId": "ddddddde395c7d64bfa611fbc",
            "spaceName": "1栋1单元门",
            "path": "/dddddddddd48e395c7d64bfa611fbc/bbbbbbbbbbf648e395c7d64bfa611fbc/",
            "code": "",
            "pathName": "1栋/1单元/单元门"
        }
    ],
    "id": "d8e9c650-8570-4261-ab35-320bc338d969"
}

results matching ""

    No results matching ""