5.4.6 HTTP API

2N HTTP API ist die Applikationsschnittstelle für die Bedienung von ausgewählten Interkomfunktionen mittels des HTTP-Protokolls. Diese Schnittstelle ermöglicht, die 2N Geräte mit Produkten Dritter, z.B. Systemen der Hausautomatisierung, Gebäudesicherungs- und Überwachungssystemem der Gebäude u.Ä. einfach zu integrieren.

Services

2N HTTP API ist gemäß der Funktion in folgende Leistungen aufgeteilt:

  • System-API – ermöglicht Konfigurationsänderungen, Erwerben des Status und Upgrade vom Gerät.
  • Verwaltung des API Zugangs – ermöglicht Steuerung der Zugriffe und Verifikationsart der Benutzerauthentisierung.
  • Schalter-API – ermöglicht die Steuerung und Kontrolle des Schalterstatus, z.B. des Öffnens der Türschlösser u.Ä.
  • I/O API – ermöglicht die Steuerung und Beaufsichtigung der logischen Eingänge und Ausgänge des Geräte.
  • Display API – ermöglicht die Displaysteuerung und das Anzeigen der Nutzerinformationen auf dem Display.
  • E-Mail API – ermöglicht aus der Anlage Nutzer-E-Mails abzusenden.
  • Telefon/Anruf-API – ermöglicht die Steuerung und Verfolgung der eingehenden und ausgehenden Anrufe.
  • Logging-API – ermöglicht aufgezeichnete Ereignisse der Anlage abzulesen.
  • Automatisierungs-API – ermöglicht die Einstellung von sicheren/unsicheren Kommunikations- und Autorisierungsanforderungen.

Man kann für jeden Dienst das Transportprotokoll (HTTP oder HTTPS) und die Authentifizierungsart (Keine, Basic oder Digest) einstellen. Man kann in der Konfiguration HTTP API bis zu fünf Nutzerkonten (mit eigenem Namen und Passwort) mit der Möglichkeit des detaillierten Zutrittes zu einzelnen Diensten und Funktionen errichten.

Für jeden Dienst können Sie die erforderliche Authentifizierungsmethode für an das Gerät gesendete Anfragen festlegen. Wird die Authentifizierung nicht durchgeführt, wird die Anfrage zurückgewiesen. Die Authentifizierung von Anfragen erfolgt über das in RFC-2617 beschriebene Standard-Authentifizierungsprotokoll. Die folgenden drei Authentifizierungsmethoden können ausgewählt werden:

  • Keine – Der Dienst erfordert keine Authentifizierung. In diesem Fall ist der Dienst im lokalen Netz völlig ungeschützt.
  • Basic – Der Dienst erfordert eine Basic-Authentifizierung gemäß RFC-2617. In diesem Fall benötigt der Dienst ein Kennwort, das jedoch in einem offenen Format gesendet wird. Wir empfehlen, diese Option nach Möglichkeit mit dem HTTPS-Protokoll zu kombinieren.
  • Digest – Der Dienst erfordert eine Digest-Authentifizierung gemäß RFC-2617. Diese Option ist die Standardeinstellung und die sicherste der oben genannten Methoden.

Die detaillierte Beschreibung und Einstellung von HTTP API ist im Handbuch 2N HTTP API. 

Konto 1–5

Die 2N Geräte ermöglicht bis zu fünf Benutzerkonten zu verwalten, die für den Zugriff auf die Dienstleistungen bestimmt sind HTTP API. Das Benutzerkonto enthält den Benutzernamen und das Benutzerpasswort sowie eine Tabelle mit den Zugriffsberechtigungen des Benutzers für jede Dienstleistung HTTP API.

  • Konto aktiviert – aktiviert dieses Benutzerkonto.

  • Benutzername – geben Sie den Benutzernamen für die Authentifizierung des HTTP API ein.
  • Passwort – geben Sie das Authentifizierungspasswort für HTTP API ein.

Mithilfe der Tabelle der Zugriffsberechtigungen können Sie die Privilegien des Benutzerkontos für einzelne Dienstleistungen steuern.