Get remote access server settings

Get remote access server settings.

If enabled - panel sends request to remote server and waits for response 10 s. If server doesn't respond during timeout panels takes access control itself. If custom server not specified request will be send to Link.

1. Device sends post request with application/json body:

{
  "identifier_number": "5a4sd7a5s4d5as3d54asd",
  "identifier_type": "card"
}

identifier_type can have three types: 'card', 'input_code' and 'qr'

2. Device waits for response with next application/json bodies:

• Access not handled. Panel should handle access itself:

  {
    "handled": false
  } 

• Access not granted:

  {
    "handled": true,
    "access": {
      "granted": false
    }
  }

• Access granted, open first lock:

  {
    "handled": true,
    "access": {
      "granted": true,
      "lock_number": 1
    }
  } 
  • where 'lock_number' (lock to open) may take next values:
    • 0 - both locks (1 and 2..8 if used SH-42 module)
    • 1..8 - indexes available for the lock number
  • also, you can use GET /access/general/lock/open/remote/accepted/{lockNumber} to open specific lock

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• enabled boolean

  describes feature status, true - on / false - off

• custom_server_enabled boolean

  Default value: false

  is remote access from custom server enabled, true - on / false - off

• custom_server_api_url string

  url

{
  "enabled": false,
  "custom_server_enabled": true,
  "custom_server_api_url": "https://bas-ip.com/api/v0/remote/validate"
}

{
  "enabled": false,
  "custom_server_enabled": false,
  "custom_server_api_url": "https://remoteserver.com"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...