5.4.6 HTTP API

HTTP API is an application interface designed for control of selected 2N devices functions via the HTTP. It enables 2N Access Units to be integrated easily with third party products, such as home automation, security and monitoring systems, etc.

Services

HTTP API provides the following services:

  • System API – provides device configuration changes, status info and upgrade.
  • API Access Control – provides access control and user authentication verification methods.
  • Switch API – provides switch status control and monitoring, e.g. door lock opening, etc.
  • I/O API – provides device logic input/output control and monitoring.
  • Display API – provides display control and user information display.
  • E-mail API – provides sending of user e-mails.
  • Logging API – provides reading of event records.
  • Automation API – provides Secure/Unsecure communication settings and authorization requirements.

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.3

Set authentication methods for the requests to be sent to the 2N devices for each service. If the required authentication is not executed, the request will be rejected. Requests are authenticated via a standard authentication protocol described in RFC-2617. The following three authentication methods are available:

  • None – no authentication is required. In this case, this service is completely unsecure in the LAN.
  • Basic – Basic authentication is required according to RFC-2617. In this case, the service is protected with a password transmitted in an open format. Thus, we recommend you to combine this option with HTTPS where possible.
  • Digest – Digest authentication is required according to RFC-2617. This is the default and most secure option of the three above listed methods. 

Refer to the 2N HTTP API Configuration Manual for the HTTP API function and configuration details.

Account 1–5

The 2N device allows you to manage up to five user accounts for access to the HTTP API services. The user account includes the user name and password and a list of user privileges to HTTP API.

  • Account Enabled – enable this user account.

  • Username – enter the username fot the HTTP authentication.
  • Password – enter the HTTP API authentication password. 

You can manage the user account priviliges to the services via the table above.