Introduction
If you’d like to use BioStar 2 New Local API as a RESTful API for your own customization or other purposes, you can simply reference this article. This article will guide you to register Suprema Mobile Access(Airfob Portal) to your users in BioStar 2 via New Local API.
Basics & Procedures
If you’d like to set an Anti PassBack option for your doors in BioStar 2, you can update the appropriate information of your door by using BioStar 2 or BioStar 2 New Local API.
There are 4 options for Anti PassBack features in BioStar 2. There are articles for 3 options out of 4 options provided in BioStar 2. Please refer to the below articles according to your needs:
- Setting APB(Output) for Doors via New Local API - ( Configuring APB(Output) via New Local API )
- Setting APB(Reboot Device) for Doors via New Local API - ( Configuring APB(Reboot Device) via New Local API )
- Setting APB(Disable Device) for Doors via New Local API - ( Configuring APB(Disable Device) via New Local API )
API Call & Parameters
- Anti PassBack(Disable Device Option)
[PUT]: /api/doors/{door_id}
[Parameters]
Name | Type | *M/O | Explanation | Value |
Id | String | M | Door id |
|
Status | String | M | Door status |
|
… |
|
|
|
|
Trigger_actions.door_id | String | O | Trigger Action Door Id |
|
Trigger_actions.input_event_id.code | String | O | Event Code | “24832” |
Trigger_actions.input_event_id.name | String | O | Event Name | “APB_ALARM” |
Trigger_actions.output_device_id.id |
| O | Output device ID |
|
Trigger_actions.output_device_id.name |
|
| Output device name |
|
Trigger_actions.output_device_id.device_type_id |
|
| Output device type ID | integer example: 18 desc: Device Type ID BIOENTRY_PLUS : 1, BIOENTRY_W : 2, BIOLITE_NET : 3, XPASS : 4, XPASS_S2 : 5, ENTRY_MAX : 5, SECURE_IO_2 : 6, DOOR_MODULE_20 : 7, BIOSTATION_2 : 8, BIOSTATION_A2 : 9, FACESTATION_2 : 10, IO_DEVICE : 11, BIOSTATION_L2 : 12, BIOENTRY_W2 : 13, CORESTATION_40 : 14, OUTPUT_MODULE : 15, INPUT_MODULE : 16, BIOENTRY_P2 : 17, BIOLITE_N2 : 18, XPASS2 : 19, XPASS_S3 : 20, BIOENTRY_R2 : 21, XPASS_D2 : 22, DOOR_MODULE_21 : 23, XPASS_D2_KEYPAD : 24, FACELITE : 25, XPASS2_KEYPAD : 26, MAX = BS2_DEVICE_TYPE_XPASS2_KEYPAD, : 26, UNKNOWN : 255, |
Trigger_actions.output_signal_id.id | String | O | Output signal ID |
|
Trigger_actions.output_signal_id.name | String | O | Output signal name |
|
Trigger_actions.output_signal_id.delay | String | O | Output signal delay |
|
Trigger_actions.output_signal_id.count | String | O | Output signal count |
|
Trigger_actions.output_signal_id.on_duration | String | O | Output signal duration |
|
Trigger_actions.output_signal_id.off_duration | String | O | Output signal off duration |
|
Trigger_actions.output_function_maek | String | O | Output function maek | “16” |
Trigger_actions.output_type | String | O | Output type | “0” |
… |
|
|
|
|
* M – Mandatory, O – Optional
[Request Body]
{ "Door": { "id": "3", "status": "0", "description": "Test Door", "entry_device_id": { "id": 547834353, "name": "FaceStation F2 547834353 (192.168.13.105)", "device_type_id": { "id": 30 } }, "open_duration": "3", "open_timeout": "10", "open_once": "false", "trigger_actions": [ { "door_id": "3", "input_event_id": { "code": "24832", "name": "APB_ALARM" }, "output_device_id": { "id": "547834353", "name": "FaceStation F2 547834353 (192.168.13.105)", "device_type_id": { "id": "30" } }, "output_signal_id": { "id": "1", "name": "Signal", "delay": "1", "count": "2", "on_duration": "3", "off_duration": "4" }, "output_function_mask": "16", "output_type": "0" } ], "relay_output_id": { "device_id": { "id": 547834353 }, "relay_index": 0 }, "sensor_input_id": { "device_id": { "id": 547834353, "name": "FaceStation F2 547834353 (192.168.13.105)" }, "input_index": 1, "type": "0", "apb_use_door_sensor": "0", "supervised": "" }, "exit_button_input_id": { "device_id": { "id": 547834353, "name": "FaceStation F2 547834353 (192.168.13.105)" }, "input_index": 0, "type": "0", "supervised": "" }, "unconditional_lock": "false", "antitailsensor_input_id": { "name": "None", "device_id": {}, "type": "0" }, "dual_authentication": { "device": "0", "approval_type": "0", "timeout": 15 }, "exit_device_id": {} } } |
[Response Body]
{ "Response": { "code": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Success" } } |
