版本：V4.0

门禁卡管理API

获取门禁卡列表

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
page_size	Integer	Body	是	每页数量
page_index	Integer	Body	是	当前页数

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
access_card_id	String	Body	门禁卡ID
access_card_name	String	Body	门禁卡名称
phone	String	Body	电话
start_time	String	Body	开始时间，UTC
finish_time	String	Body	结束时间，UTC
created_time	String	Body	创建时间，UTC

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_card_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "access_card_name": "test",
      "access_card_id": "arbr2c4b070cc928496198944858b344f",
      "phone": "1234567",
      "start_time": "2025-04-16 13:32:45",
      "finish_time": "2025-04-17 13:32:45",
      "created_time": "2025-03-29 08:48:18"
    }
  ]
}

失败返回示例

见接口失败返回

获取门禁卡信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_card_id	String	Body	是	门禁卡ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
access_card_name	String	Body	门禁卡名称
phone	String	Body	电话
rf_card_number	String	Body	射頻卡号
access_group_id	String	Body	权限组ID
start_time	String	Body	开始时间，UTC
finish_time	String	Body	结束时间，UTC
created_time	String	Body	创建时间，UTC

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_id": "arbr2c4b070cc928496198944858b344f"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "access_card_name": "test",
    "phone": "1234567",
    "rf_card_number": "123456",
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "start_time": "2025-04-16 13:32:45",
    "finish_time": "2025-04-17 13:32:45",
    "created_time": "2025-03-29 08:48:18"
  }
}

失败返回示例

见接口失败返回

创建门禁卡信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_card_name	String	Body	是	门禁卡名称
phone	String	Body	是	电话
rf_card_number	String	Body	是	射頻卡号
access_group_id	String	Body	是	权限组ID
start_time	String	Body	是	开始时间，UTC
finish_time	String	Body	是	结束时间，UTC

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
access_card_id	String	Body	门禁卡ID

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_name": "test",
    "phone": "1234567",
    "rf_card_number": "123456",
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "start_time": "2025-04-16 13:32:45",
    "finish_time": "2025-04-17 13:32:45"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_card_id": "a2a621c1ae77040d697bd2134700f57ea"
  }
}

失败返回示例

见接口失败返回

更新门禁卡信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_card_id	String	Body	是	门禁卡ID
access_card_name	String	Body	是	门禁卡名称
phone	String	Body	是	电话
rf_card_number	String	Body	是	射頻卡号
access_group_id	String	Body	是	权限组ID
start_time	String	Body	是	开始时间，UTC
finish_time	String	Body	是	结束时间，UTC

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_id": "a2a621c1ae77040d697bd2134700f57ea",
    "access_card_name": "test",
    "phone": "1234567",
    "rf_card_number": "123456",
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "start_time": "2025-04-16 13:32:45",
    "finish_time": "2025-04-17 13:32:45"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

删除门禁卡信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_card_id	String	Body	是	门禁卡ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_id": "arbr2c4b070cc928496198944858b344f"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

获取权限组列表

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
page_size	Integer	Body	是	每页数量
page_index	Integer	Body	是	当前页数

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
access_group_id	String	Body	权限组ID
access_group_name	String	Body	权限组名称
created_time	String	Body	创建时间，UTC

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_group_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "access_group_name": "test",
      "access_group_id": "arbr2c4b070cc928496198944858b344f",
      "created_time": "2025-03-29 08:48:18"
    }
  ]
}

失败返回示例

见接口失败返回

获取权限组信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_group_id	String	Body	是	权限组ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
access_group_name	String	Body	权限组名称
created_time	String	Body	创建时间，UTC
residences	[]Object<residence>	Body	住宅信息
public_access_groups	[]Object<public_access_group>	Body	公共权限组信息

residence说明

参数名	类型	位置	说明
residence_id	String	Body	住宅ID

public_access_group说明

参数名	类型	位置	说明
public_access_group_id	String	Body	公共权限组ID

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_id": "arbr2c4b070cc928496198944858b344f"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "access_group_name": "test",
    "created_time": "2025-03-29 08:48:18",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ],
    "public_access_groups": [
      {
        "public_access_group_id": "a31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

失败返回示例

见接口失败返回

创建权限组信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_group_name	String	Body	是	权限组名称
residences	[]Object<residence>	Body	是	住宅信息
public_access_groups	[]Object<public_access_group>	Body	是	公共权限组信息

residence说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

public_access_group说明

参数名	类型	位置	必填	说明
public_access_group_id	String	Body	是	公共权限组ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
access_group_id	String	Body	权限组ID

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_name": "test",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ],
    "public_access_groups": [
      {
        "public_access_group_id": "a31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea"
  }
}

失败返回示例

见接口失败返回

更新权限组信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_group_id	String	Body	是	权限组ID
access_group_name	String	Body	是	权限组名称
residences	[]Object<residence>	Body	是	住宅信息
public_access_groups	[]Object<public_access_group>	Body	是	公共权限组信息

residence说明

参数名	类型	位置	必填	说明
residence_id	String	Body	是	住宅ID

public_access_group说明

参数名	类型	位置	必填	说明
public_access_group_id	String	Body	是	公共权限组ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "access_group_name": "test",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ],
    "public_access_groups": [
      {
        "public_access_group_id": "a31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

删除权限组信息

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
access_group_id	String	Body	是	权限组ID

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	Object	Body	返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_id": "arbr2c4b070cc928496198944858b344f"
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失败返回示例

见接口失败返回

获取公共权限组列表

接口地址

POST /api/v1.0/invoke/open-ability/method/hotel-commands

请求参数

参数名	类型	位置	必填	说明
Content-Type	String	Header	是	内容类型，值为application/json
Accept	String	Header	是	接受类型，值为application/json
Authorization	String	Header	是	Bearer认证，访问令牌
command	String	Body	是	命令名称
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令参数

param说明

参数名	类型	位置	必填	说明
page_size	Integer	Body	是	每页数量
page_index	Integer	Body	是	当前页数

返回参数

参数名	类型	位置	说明
Content-Type	String	Header	内容类型，值为application/json
success	Boolean	Body	判断请求是否成功 true：成功 false：失败
timestamp	Integer	Body	时间戳
result	[]Object<result>	Body	返回结果

result说明

参数名	类型	位置	说明
public_access_group_id	String	Body	公共权限组ID
public_access_group_name	String	Body	公共权限组名称
public_access_group_type	String	Body	公共权限组类型 system：系统 customized：定制
repeat_mode	String	Body	重复模式 never：从不 daily：每日 weekly：每周
start_time	String	Body	开始时间，UTC
finish_time	String	Body	结束时间，UTC
available_days	[]String	Body	可用时间
user_count	Integer	Body	用户数
created_time	String	Body	创建时间，UTC

请求示例

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_public_access_group_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例

状态码：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "public_access_group_name": "test",
      "public_access_group_id": "arbr2c4b070cc928496198944858b344f",
      "public_access_group_type": "system",
      "start_time": "00:00:00",
      "finish_time": "23:59:59",
      "repeat_mode": "daily",
      "available_days": [],
      "user_count": 0,
      "created_time": "2025-03-29 08:48:18"
    }
  ]
}

失败返回示例

见接口失败返回

获取门禁卡列表​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取门禁卡信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

创建门禁卡信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

更新门禁卡信息​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

删除门禁卡信息​

接口地址​

请求参数​

param说明​

返回参数​

请求示例​

成功返回示例​

失败返回示例​

获取权限组列表​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

获取权限组信息​

接口地址​

请求参数​

param说明​

返回参数​

result说明​

residence说明​

public_access_group说明​

请求示例​

成功返回示例​

失败返回示例​

创建权限组信息​

接口地址​

请求参数​

param说明​

residence说明​

public_access_group说明​

返回参数​

result说明​

请求示例​

成功返回示例​

失败返回示例​

更新权限组信息​

接口地址​

请求参数​

param说明​

residence说明​

public_access_group说明​

获取门禁卡列表

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取门禁卡信息

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

创建门禁卡信息

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

更新门禁卡信息

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

删除门禁卡信息

接口地址

请求参数

param说明

返回参数

请求示例

成功返回示例

失败返回示例

获取权限组列表

接口地址

请求参数

param说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

获取权限组信息

接口地址

请求参数

param说明

返回参数

result说明

residence说明

public_access_group说明

请求示例

成功返回示例

失败返回示例

创建权限组信息

接口地址

请求参数

param说明

residence说明

public_access_group说明

返回参数

result说明

请求示例

成功返回示例

失败返回示例

更新权限组信息

接口地址

请求参数

param说明

residence说明

public_access_group说明