5.4.5 HTTP API

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

Services

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

  • System-API – ermöglicht Konfigurationsänderungen, Erwerben des Status und Upgrade vom Interkom.
  • 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 Interkoms.
  • Audio-API – ermöglicht die Steuerung des Tonabspielens und der Überwachung des Anlagenmikrophons.
  • Kamera-API – ermöglicht die Steuerung und Verfolgung des Bildes aus der Kamera.
  • 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.

Die detaillierte Beschreibung und Einstellung von HTTP API ist im Handbuch HTTP API angeführt. 

Tipp

  • Für die Funktion Video Preview auf dem Telefon Gigaset Maxwell 10 muss man in der Registerkarte HTTP API bei der Position Camera API denTyp des Anschlusses = Nicht gesichert (TCP) und der Authentifizierung = Keine einstellen.

Konto 1–5

2N IP interkom 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.