--- title: "Integration with Third-Party Device" slug: "integration-with-third-party-device-23" updated: 2026-09-11T01:53:49Z published: 2026-09-11T01:53:49Z canonical: "knowledge.akuvox.com/integration-with-third-party-device-23" stale: true --- > ## Documentation Index > Fetch the complete documentation index at: https://knowledge.akuvox.com/llms.txt > Use this file to discover all available pages before exploring further. # Integration with Third-Party Device ## Integration via Wiegand The Wiegand feature enables the Akuvox device to act as a controller or a card reader. Set it up on the web **Device > Wiegand** interface. ![](https://cdn.document360.io/f09a6106-e976-455e-b2d0-3d88b5385960/Images/Documentation/image-E0UTGWB7.png) - **Wiegand Display Mode**: Select the Wiegand card code format from the following options: 8H10D, 6H3D5D(W26), 6H8D, 8HN, 8HR, 6H3D5D-R(W26), 8HR10D, and RAW. - **Wiegand Card Reader Mode**: The transmission format should be identical between the door phone and the third-party device. It is automatically configured for **Input** Wiegand transfer mode. - **Wiegand Transfer Mode**: - **Input**: The device serves as a receiver. - **Output**: The device serves as a sender and can directly output the data, such as the card code. - **Convert To Card No. Output**: The device serves as a sender and cannot directly output the data, such as the face data and fingerprint data. - **Wiegand Input Clear Time**: When the interval between entering passwords exceeds this time. All entered passwords will be cleared. - **Wiegand Input Data Order**: Set the Wiegand input data sequence between Normal and Reversed. If you select Reversed, then the input card number will be reversed. - **Wiegand Output Basic Data Order**: Set the sequence of the card data before going through Wiegand conversion and outputting the card code. For example, if the card data is 0x11 0x22 0x33 0x44 and the **Reversed** option is selected, the data will be 0x44 0x33 0x22 0x11. - **Wiegand Output Data Order:** Determine the sequence of the card data after the Wiegand conversion. For example, if the card data is 0x11 0x22 0x33 0x44 0x55, it will be 0x33 0x44 0x55 after the Wiegand conversion(e.g., Wiegand 26). If **Reversed** is selected, the card data is 0x55 0x44 0x33. - **Wiegand Output CRC Enabled**: It is enabled by default for Wiegand data inspection. Disabling it may lead to integration failure with third-party devices. - **RF Card Verification**: Available when **Output** or **Convert to Card No. Output** is selected. When enabled, the device will verify whether the card code is assigned to a user. If it is not, a prompt "Opening Door Failed" will pop up on the door phone screen. When disabled, the door phone will not perform local verification. - **PIN/QR Code Verification**: Available when **Output** is selected as Wiegand Transfer Mode. When enabled, the device will verify whether the credential is assigned to a user. If it is not, a prompt "Opening Door Failed" will pop up on the door phone screen. When disabled, the door phone will not perform local verification. - **Wiegand Open Relay**: Check the relay to be triggered through Wiegand. > [!NOTE] > Note > > Click [here](https://knowledge.akuvox.com/docs/wiegand-configuration) to view more information on Wiegand settings, including: > > - Akuvox devices work as Wiegand input/output. > - Wiegand Card Reader Connection. When the device is in Wiegand Output mode, you can set the Wiegand PIN code output format that determines how data is transmitted. The format should be consistent with that of the third-party device. Set it up on the **Device > Wiegand > Convert To Wiegand Output** interface. ![](https://cdn.document360.io/f09a6106-e976-455e-b2d0-3d88b5385960/Images/Documentation/image-96U5J11C.png) - **8 bits per digit**: When users press "1" on the keypad, the binary data will be transmitted in 8 bits, "11100001". - **4 bits per digit**: When users press "1" on the keypad, the binary data will be transmitted in 4 bits, "0001". - **All at once**: After users enter the whole PIN code, the data will be transmitted according to the Wiegand card reader mode. For example, “123456” will be converted to “01e240” in Wiegand 26. ## Integration via HTTP API HTTP API is designed to achieve a network-based integration between the third-party device and the Akuvox device. To set it up, go to the web **Setting > HTTP API** interface. ![](https://cdn.document360.io/f09a6106-e976-455e-b2d0-3d88b5385960/Images/Documentation/image-44IOCPE7.png) - **Enabled**: Enable or disable the HTTP API function for third-party integration. If the function is disabled, any request to initiate the integration will be denied and return an HTTP 403 forbidden status. - **Authorization Mode**: Select among the following options: None, Normal, Allowlist, Basic, Digest, and Token for authorization type, which will be explained in detail in the following chart. - **Username**: Enter the username when **Basic** or **Digest** authorization mode is selected. The default username is admin. - **Password**: Enter the password when **Basic** or **Digest** authorization mode is selected. The default password is admin. - **1st IP-5th IP**: Enter the IP address of the third-party devices when **Allowlist** authorization is selected for the integration. **Please refer to the following description for the authentication mode:** | NO. | Authorization Mode | Description | | --- | --- | --- | | 1 | None | No authentication is required for HTTP API as it is only used for demo testing. | | 2 | Normal | This mode is used by Akuvox developers only. | | 3 | Allowlist | If this mode is selected, you are only required to fill in the IP address of the third-party device for the authentication. The allowlist is suitable for operation in the LAN. | | 4 | Basic | If this mode is selected, you are required to fill in the username and password for the authentication. In the Authorization field of the HTTP request header, use the Base64 encoding method to encode of username and password. | | 5 | Digest | The password encryption method only supports MD5. MD5( Message-Digest Algorithm) In the Authorization field of HTTP request header: WWW-Authenticate: Digest realm="HTTPAPI",qop="auth,auth-int",nonce="xx", opaque="xx". | | 6 | Token | This mode is used by Akuvox developers only. | ## Power Output Control The device can serve as a power supply for the external relays. Click [here](https://knowledge.akuvox.com/docs/devices-supporting-12v-power-output) to view the power output requirements and the [wiring example](https://knowledge.akuvox.com/docs/devices-supporting-12v-power-output#wiring). To set it up, go to the web **Access Control > Relay > 12V Relay Output** interface. ![](https://cdn.document360.io/f09a6106-e976-455e-b2d0-3d88b5385960/Images/Documentation/image-PX71EJWI.png) - **12V Power Output**: - **Always**: Provide continuous power to the third-party device. - **Triggered by Open Relay**: Provide power to the third-party device via 12 output and GND interface during the timeout when the status of relays is shifted from low to high. ## Integration via RS485 You can connect the device to an external device such as SR01 or an OSDP-based card reader via RS485. To make the connection effective, you need to select the right RS485 mode. Click [here](https://knowledge.akuvox.com/docs/configure-osdp-on-door-phonesaccess-control-terminals) to view the detailed configuration of the OSDP feature. To make the connection effective, you need to set up the RS485 on the **Device > RS485** interface. ![](https://cdn.document360.io/f09a6106-e976-455e-b2d0-3d88b5385960/Images/Documentation/image-PNBSO76C.png) - **Disabled**: The RS485 function is disabled. - **OSDP**: The device is connected to an OSDP-based external device such as a card reader. - **Encryption**: Check this option when the protocol is encrypted. - **Transfer Mode**: Select the RS485 working mode, Output, or Input. - **Local Relay Verification**: When Output is selected, set whether to carry out the access credentials verification. When unchecked, door-opening failure prompts will not be given. - **SCBK Value**: Secure Communication Key Value. - When it is filled, OSDP will use this value for encryption, employing a customized protocol for communication. - When it is left empty, OSDP will use the default encrypted protocol for communication. - **Others**: Select this option when the device works with the SR01. ## Integration with Third-party Access Control Server The device can transmit access credential data to a third-party server without doing local verification. The generation and verification of the data are conducted on the third-party server. To set it up, go to **Access Control > Relay > Third Party Integration** interface. ![](https://cdn.document360.io/f09a6106-e976-455e-b2d0-3d88b5385960/Images/Documentation/image-054QEMR9.png) - **List**: - **None**: Disable the function. - **General**: Transmit the QR code-linked HTTP URL in Akuvox’s method. - **HTTP URL**: Enter the HTTP command format provided by the third-party service provider. After scanning the QR code, the HTTP command will carry the dynamic QR code information automatically before it is sent to the QR code server for verification. See the example: *http://{Server IP}:8090/api/visitor/scan?codeKey={QRCode}&deviceId={DeviceID}.* - **Device ID**: The device ID is provided by the third-party server. It will be added to the HTTP command automatically when using a QR code for door access. - **Success Parameter**: Receiving this value indicates that opening the door succeeds. - **Failed Parameter**: Receiving this value indicates that opening the door fails. - **Customize**: Transmit access credential data in a customized method. - **Prompt on LCD**: Select **Default** to adopt the Akuvox door phone’s door-opening prompt; Select **Return Value** to use the return value from the third-party server as the prompt. - **Remote Verification**: Check the access method(s) to be verified by the third-party server. When **Face** is selected, the device performs local face recognition first. If no matching face is detected, authentication fails. If a match is found, the associated **User ID** or **PIN** is submitted to the third-party server for further verification. - **HTTP URL**: Enter the HTTP command in a format provided by the third-party service provider. After QR code scanning, card swiping, PIN entry, or facial recognition, the HTTP command will carry the dynamic information automatically before it is sent to the server for verification. See the example: *http://{Server IP}:8090/api/visitor/scan?codeKey={QRCode}/{Card}/{Pin}/{UserID}&deviceId={DeviceID}.* For example, if a user swipes the RF card, the URL will be *http://192.168.35.123:8090/api/visitor/scan?codeKey={QRCode}/45678999/{Pin}/{UserID}&deviceId=1*. - **Device ID**: The device ID is provided by the third-party server. It will be added to the HTTP command automatically when using the access credential for door access. - **Success Parameter**: Receiving this value indicates that opening the door succeeds. - **Failed Parameter**: Receiving this value indicates that opening the door fails.