版本：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說明