1. Introduction
HTTP API is an application interface designed for control of selected 2N IP intercoms functions via the HTTP. It enables 2N IP intercoms to be integrated easily with third party products, such as home automation, security and monitoring systems, etc.
HTTP API provides the following services:
- System API – provides intercom configuration changes, status info and upgrade.
- Switch API – provides switch status control and monitoring, e.g. door lock opening, etc.
- I/O API – provides intercom logic input/output control and monitoring.
- Audio API – provides audio playback control and microphone monitoring.
- Camera API – provides camera image control and monitoring.
- Display API – provides display control and user information display.
- E-mail API – provides sending of user e-mails.
- Phone/Call API – provides incoming/outgoing call control and monitoring.
- Logging API – provides reading of event records.
Set the transport protocol (HTTP or HTTPS) and way of authentication (None, Basic or Digest) for each function. Create up to five user accounts (with own username and password) in the HTTP API configuration for detailed access control of services and functions.
Use the configuration web interface on the Services / HTTP API tab to configure your HTTP API. Enable and configure all the available services and set the user account parameters.
Refer to http(s)://ip_intercom_address/apitest.html for a special tool integrated in the intercom HTTP server for HTTP API demonstration and testing.
Caution
Warning
In order to ensure the full functionality and guaranteed performance, we strongly recommend that the topicality of the product / device version in use be verified as early as in the installation process. The customer hereby acknowledges that the product / device can achieve the guaranteed performance and full functionality pursuant to the manufacturer’s instructions only if the latest product / device version is used after having been tested for full interoperability and not having been determined by the manufacturer as incompatible with certain versions of other products, and only in conformity with the manufacturer’s instructions, guidelines or recommendations and in conjunction with suitable products and devices of other suppliers. The latest versions are available at https://www.2n.com/cs_CZ/ or can be updated via the configuration interface if the devices are adequately technically equipped. Should the customer use a product / device version other than the latest one or a version determined by the manufacturer as incompatible with certain versions of other products, or should the customer use the product / device in contradiction to the manufacturer’s instructions, guidelines or recommendations or in conjunction with unsuitable products / devices of other suppliers, the customer is aware of and agrees with all functionality limitations of such a product / device if any as well as with all consequences incurred as a result thereof. Using a product / device version other than the latest one or a version determined by the manufacturer as incompatible with certain versions of other products, or using the product / device in contradiction to the manufacturer’s instructions, guidelines or recommendations or in conjunction with unsuitable products / devices of other suppliers, the customer agrees that the 2N TELEKOMUNIKACE a.s. company shall not be held liable for any functionality limitation of such a product or any damage, loss or injury related to this potential functionality limitation.