BAS-IP Link API: Integration von Türsprechanlage und Zutrittskontrolle
Ein neuer Bewohner wird zunächst in dem System angelegt, das die Hausverwaltung bereits für Wohnungen, Bewohner und Kontaktdaten nutzt. Dann wird dieselbe Person noch einmal angelegt, diesmal im Türkommunikationssystem (Zutrittskontrolle). Zugangsberechtigungen ändern sich – zwei Systeme müssen aktualisiert werden. Der Bewohner zieht aus – der Datensatz muss zweimal entfernt werden.
An einem einzelnen Standort ist das einfach nur zusätzlicher Verwaltungsaufwand. Über ein ganzes Immobilienportfolio hinweg mit regelmäßigen Einzügen, Zugangsänderungen und temporären Ausweisen wird daraus ein separater Verwaltungsprozess, den ursprünglich niemand wirklich wollte.
Was sind BAS-IP Link und Link API?
BAS-IP Link ist die zentralisierte Plattform von BAS-IP zur Verwaltung von Standorten, Benutzern, Zugangsrechten und vernetzter Infrastruktur.
Die BAS-IP Link API ist eine HTTP-REST-API, die es einem serverseitigen Drittsystem ermöglicht, programmgesteuert mit Link zu interagieren: Benutzerdaten übergeben, Zugangsrechte und Anmeldeinformationen verwalten und Daten von der Plattform abrufen.
Der Sinn besteht nicht darin, dem Personal ein weiteres System für die Arbeit zur Verfügung zu stellen. Ganz im Gegenteil: Die bestehende Plattform des Kunden kann die primäre operative Schnittstelle bleiben, während BAS-IP Teil der dort bereits verwalteten Prozesse wird.
Wie sieht das in der Praxis aus? Einen neuen Bewohner hinzufügen
Die Hausverwaltung kennt bereits den Namen, die Wohnung, die Kontaktdaten und andere relevante Informationen des Bewohners. Diese Daten existieren bereits im eigenen System.
Ohne Integration muss ein Mitarbeiter dann BAS-IP Link öffnen und denselben Benutzer erneut anlegen.
Mit der Link API kann dieser zweite Schritt automatisiert werden. Das Hauptsystem übergibt die erforderlichen Daten an Link, der Benutzer wird dem entsprechenden Standort und der entsprechenden Wohnung zugeordnet, und BAS-IP Link arbeitet dann mit der angeschlossenen Türkommunikations- und Zugangsinfrastruktur.
Der praktische Wert liegt nicht nur darin, dass zwei Systeme Daten austauschen können. Er besteht darin, dass die Mitarbeiter ihre bisherige Arbeitsweise nicht ändern müssen.
Wenn Einzüge, Änderungen von Bewohnerdaten und Auszüge bereits in der Hauptplattform verwaltet werden, müssen dieselben Aktionen nicht manuell im Türkommunikationssystem wiederholt werden.
Warum Link API verwenden, wenn BAS-IP-Geräte eine eigene API haben?
BAS-IP unterstützt auch die direkte Integration mit Geräten über die BAS-IP Device API.
Für ein lokales Projekt kann das der richtige Ansatz sein. Wenn ein System mit einem oder mehreren bekannten Gerätemodellen zusammenarbeiten muss und nur begrenzte Funktionen erfordert, ist eine zusätzliche Serverschicht möglicherweise nicht notwendig.
Die Anforderung ändert sich jedoch, wenn das Projekt skaliert.
In verschiedenen Gebäuden können unterschiedliche Türstationen, Innenmonitore und andere Geräte zum Einsatz kommen. Im Laufe der Zeit werden neue Modelle und Firmware-Versionen eingeführt. Bei einer direkten Geräteintegration muss das externe Entwicklungsteam die Eigenschaften der Geräte berücksichtigen, mit denen es sich integriert.
BAS-IP Link fügt eine zentralisierte Softwareschicht zwischen der Drittanbieter-Plattform und der Türkommunikationsinfrastruktur hinzu.
Anstatt ihre Geschäftslogik um eine bestimmte Türstation herum aufzubauen, arbeitet die externe Plattform mit dem zentralen Modell von Link für Benutzer, Standorte, Wohnungen, Zugangsrechte und andere Entitäten.
Dies ist im Allgemeinen ein natürlicheres Modell für eine Plattform zur Verwaltung von Wohnimmobilien. Sie muss normalerweise nicht wissen, welche genaue Türstation an einer bestimmten Tür installiert ist. Sie muss wissen, dass ein bestimmter Bewohner zu einer bestimmten Wohnung gehört und Zugang zu den entsprechenden Bereichen haben sollte.
BAS-IP Link verbindet diese Geschäftslogik mit der physischen Infrastruktur für Türkommunikation und Zutrittskontrolle.
Was können Sie mit der BAS-IP Link API tun?
Eine bestimmte Integration wird normalerweise nur einen Teil der in Link verfügbaren Funktionen nutzen.
Über die API kann ein Drittsystem arbeiten mit:
- Benutzern und Standortstruktur;
- Zugriffsrechten;
- permanenten und temporären Zugangsdaten, einschließlich Karten, Schlüsselanhängern, PIN-Codes, QR-Codes, Face ID, UKEY und Kfz-Kennzeichen;
- Gastzugang und Besuchern;
- Nachrichten und Umfragen;
- virtuellen Nummern und Rufumleitung;
- Remote-Gerätekonfiguration;
- Ereignissen und Protokollen.
Ein Integrationsprojekt lässt sich jedoch meist besser durch eine andere Frage definieren als „Welche API-Methoden sind verfügbar?“.
Welche Aufgaben werden heute manuell ausgeführt, und welche davon sollten nach der Integration der Systeme automatisch ablaufen?
Für die eine Plattform kann der primäre Anwendungsfall die Bewohnerverwaltung sein. Für eine andere kann es der temporäre Zugang für Handwerker sein. Eine dritte benötigt möglicherweise hauptsächlich Ereignisdaten.
Verwaltung des gesamten Benutzerlebenszyklus, nicht nur die Benutzererstellung
Das Erstellen eines Benutzers ist nur der erste Schritt.
Sobald ein Bewohner hinzugefügt wurde, können die entsprechenden Zugangsrechte und Identifikationsmittel zugewiesen werden. Wenn der Bewohner in eine andere Wohnung zieht, das Fahrzeug wechselt, zusätzliche Berechtigungen erhält oder den Zugang verliert, können diese Änderungen ebenfalls in den Workflow der Hauptplattform integriert werden.
Das gleiche Prinzip gilt für temporäre Benutzer.
Wenn ein bestehendes System bereits Besucher, Handwerker oder Servicepersonal verwaltet, ist es nicht erforderlich, einen separaten administrativen Prozess rein für BAS-IP zu schaffen.
Beispielsweise kann die Hauptplattform festlegen, dass ein Handwerker am Dienstag zwischen 10:00 und 14:00 Uhr ein Gebäude betreten darf. In diesem Szenario wird BAS-IP zur Zugangsschicht, die einen bereits an anderer Stelle definierten Prozess ausführt.
Türkommunikation und Zutrittskontrolle werden so Teil des umfassenderen Betriebsmodells des Gebäudes und nicht ein separates System, das unabhängig verwaltet werden muss.
Was ist, wenn der Standort bereits in Betrieb ist und eine große Benutzerbasis hat?
Eine Integration beginnt nicht zwingend mit einer leeren Datenbank.
Wenn ein bestehendes System bereits Hunderte oder Tausende von Bewohnern enthält, müssen diese nicht einzeln manuell in BAS-IP Link eingegeben werden.
Bei Verwendung der BAS-IP Link API kann die Methode zur Benutzererstellung in einer einzigen Anfrage mehrere Benutzer hinzufügen.
Eine garantierte maximale Anzahl von Datensätzen pro Vorgang sowie die zulässige Häufigkeit aufeinanderfolgender Anforderungen sind derzeit nicht festgelegt. Bei einer großen Migration sollten diese Parameter daher in der Testumgebung des Projekts validiert werden, bevor die gesamte Benutzerbasis verschoben wird.
Implementierungsdetails für die API-Methode werden Integrationspartnern in der technischen Dokumentation zur Verfügung gestellt.
Es gibt auch eine integrierte Option für die Massenerstellung von Benutzern, ohne eine API-Integration entwickeln zu müssen.
BAS-IP Link kann die Standortstruktur in eine XLS-Datei exportieren. Benutzer- und Lizenzdetails werden dann in der Tabelle ergänzt und wieder in Link importiert. Nach dem Import werden die Benutzer automatisch den angegebenen Standortgruppen zugewiesen. Wenn mehrere Benutzer zur selben Wohnung oder einer anderen Standortgruppe gehören, können separate Zeilen dieselbe Gruppenkennung verwenden.
Für eine anfängliche Einführung im Wohnbereich ist es nicht erforderlich, für jedes Haushaltsmitglied eine E-Mail-Adresse zu erfassen. Eine E-Mail-Adresse pro Wohnung reicht aus: Der eingeladene Benutzer erhält eine E-Mail, schließt die Registrierung ab und kann dann selbst Familienmitglieder hinzufügen.
Für ein bestehendes Projekt kann das Projektteam daher zwischen einer automatisierten API-Migration und dem integrierten Massen-Upload-Prozess von Link wählen, abhängig von der Systemarchitektur und dem Speicherort der Quell-Benutzerdatenbank.
Können BAS-IP-Ereignisse in einem anderen System verwendet werden?
Ja. In Link gehaltene Daten und Ereignisse können von einem Drittsystem verwendet werden.
Beispielsweise arbeitet ein Sicherheitsteam möglicherweise bereits mit einer einzigen Benutzeroberfläche, die Informationen aus Zutrittskontrolle, Videoüberwachung und anderen Gebäudesystemen zusammenführt. BAS-IP-Daten können Teil desselben operativen Workflows sein.
Es gibt jedoch einen wichtigen technischen Unterschied.
BAS-IP Link bietet derzeit keine Webhooks zum Übertragen von Ereignissen an Drittsysteme. Das externe System ruft die erforderlichen Daten ab, indem es Anfragen an die Link API stellt.
Wenn ein Projekt erfordert, dass bestimmte Ereignisse direkt von der Hardware über Webhooks geliefert werden, ist dieses Szenario auf unterstützten Android-basierten Türstationen über die BAS-IP Device API verfügbar.
Ein Projekt kann daher eine zentralisierte Integration über Link mit der direkten Interaktion mit ausgewählten Geräten kombinieren, wo dies erforderlich ist.
Welches System sollte die „Single Source of Truth“ sein?
Eine der wichtigsten Entscheidungen bei einer Integration ist, welches System für welche Art von Daten verantwortlich ist.
Wenn derselbe Benutzer unabhängig voneinander in der Immobilienverwaltungsplattform und in BAS-IP Link geändert werden kann, können die Datensätze inkonsistent werden.
Beispielsweise kann die Immobilienverwaltungsplattform weiterhin für Bewohner und Wohnungen zuständig sein, BAS-IP Link wendet diese Informationen auf die Türkommunikation und Zutrittskontrolle an, während eine separate Sicherheitsplattform die von den Operatoren benötigten Ereignisdaten verbraucht.
Ein anderes Projekt könnte die Verantwortlichkeiten anders aufteilen.
Der entscheidende Punkt ist nicht, dass BAS-IP oder die Drittanbieterplattform immer das „Master“-System sein muss. Es geht darum, dass die maßgebliche Quelle für jede Entität und die Synchronisationsrichtung klar definiert sein sollten.
Dadurch wird doppelter Verwaltungsaufwand vermieden, anstatt einfach nur zwei Datenbanken miteinander zu verbinden.
Wo ist die Link API am nützlichsten?
Die Link API ist besonders relevant, wenn BAS-IP Teil eines bestehenden Software-Ökosystems werden soll.
Typische Beispiele sind:
- Plattformen für Wohn- und Immobilienverwaltung;
- Große Zutrittskontrollsysteme;
- BMS- und Smart-Building-Plattformen;
- PropTech-Produkte;
- Eigene Softwareplattformen von Integratoren;
- Plattformen, die mehrere Gebäude oder Standorte verwalten.
Je mehr Benutzer, Gebäude und regelmäßige Zugangsänderungen ein Projekt aufweist, desto mehr Verwaltungsaufwand wird dupliziert, wenn die Systeme getrennt bleiben.
Der Wert der Link API definiert sich daher meist nicht durch die Anzahl der verfügbaren API-Methoden, sondern durch die Anzahl der getrennten operativen Prozesse, die zusammengeführt werden können.
Sicherheit und Integrationsberechtigungen
Ein Drittsystem benötigt keinen uneingeschränkten administrativen Zugriff auf Link.
In BAS-IP Link Self-Hosted kann ein dediziertes Integrationskonto erstellt werden, dessen Berechtigungen sowohl nach Funktion als auch nach einzelnem Standort eingeschränkt werden können.
So kann eine Integration, die von einem bestimmten Immobilienbetreiber genutzt wird, auf die Gebäude beschränkt werden, die von dieser Organisation verwaltet werden.
Die Authentifizierung verwendet Zugriffstoken, und die API-Kommunikation erfolgt über HTTPS.
Der detaillierte Authentifizierungsablauf und die Anfrage-Strukturen werden in der technischen Dokumentation der Link API behandelt.
BAS-IP Link Self-Hosted und Link Cloud
Zum Zeitpunkt der Veröffentlichung werden serverseitige Drittanbieter-Integrationen über die BAS-IP Link API auf BAS-IP Link Self-Hosted unterstützt.
BAS-IP entwickelt ein separates API-Gateway für die BAS-IP Link Cloud.
Wenn ein Projekt speziell eine Drittanbieter-Integration mit der Link Cloud erfordert, sollte die vorgeschlagene Architektur vor Beginn der Entwicklung mit BAS-IP besprochen werden.
Wie starte ich eine Integration?
Ein Link API-Projekt beginnt mit dem Anwendungsfall (Use Case) und nicht mit einer Liste von API-Aufrufen.
Beispielsweise:
„Wenn wir in unserer Plattform einen Bewohner anlegen, möchten wir, dass der Benutzer automatisch am richtigen BAS-IP-Standort angelegt wird.“
Das reicht aus, um eine architektonische Diskussion zu beginnen.
Sobald das Integrationsszenario vereinbart ist, unterzeichnet der Partner eine NDA und erhält die relevanten technischen Materialien.
Die Integration selbst wird normalerweise vom Team des Partners entwickelt. Ein typisches Projekt erfordert in der Regel einen Back-End- oder Full-Stack-Entwickler. Größere Bereitstellungen können auch DevOps-Expertise erfordern.
Für Entwicklung und Tests kann BAS-IP Link Self-Hosted in der eigenen Umgebung des Partners bereitgestellt werden. Es gibt derzeit keine gemeinsam genutzte öffentliche Sandbox für die Link API. Testlizenzen und Hardware-Vereinbarungen werden entsprechend den Anforderungen des jeweiligen Projekts getroffen.
BAS-IP stellt die Dokumentation zur Verfügung, beantwortet technische Fragen zu den eigenen Produkten und hilft bei der Untersuchung von Fällen, in denen sich eine auf der Dokumentation basierende Implementierung nicht wie erwartet verhält.
Wenn ein Projekt Funktionen erfordert, die derzeit im Produkt nicht verfügbar sind, kann diese Anforderung mit dem Produktteam besprochen werden. Dabei wird zunächst der damit verbundene Aufwand und dessen Platz im Entwicklungsplan abgeschätzt. Eine solche Bewertung stellt an sich noch keine Verpflichtung für ein bestimmtes Veröffentlichungsdatum dar.
Wie lange dauert eine Link API-Integration?
Es gibt keinen einheitlichen Zeitplan, der für jedes Projekt gilt.
Für eine relativ standardmäßige Integration kann etwa ein Monat fokussierter Entwicklungszeit als grober Richtwert dienen, obwohl die kalendarische Dauer oft länger ist.
Das Entwicklungsteam des Partners benötigt Zeit, um das Link-Datenmodell zu verstehen, seinen Teil der Integration zu implementieren, diesen zu testen und die Arbeit in seinen eigenen Entwicklungsplan einzupassen.
Eine sinnvolle Schätzung kann daher erst vorgenommen werden, wenn das tatsächliche Integrationsszenario definiert wurde.
Gibt es zusätzliche Kosten für die BAS-IP Link API?
BAS-IP erhebt normalerweise keine separate Gebühr für den Zugang zur Dokumentation und den Integrationswerkzeugen.
BAS-IP Link selbst wird unter dem Standard-Produktlizenzmodell lizenziert. Der Partner entwickelt seine eigene Seite der Integration, während nicht standardmäßige Entwicklungsarbeiten von BAS-IP oder Anfragen zur Änderung der Priorität solcher Arbeiten bei Bedarf separat besprochen werden können.
Aus diesem Grund kann es irreführend sein, die Integration selbst als „kostenlos“ zu bezeichnen.
Genauer ist die Aussage, dass für den Zugang zu den BAS-IP-Integrationswerkzeugen in der Regel keine separate Gebühr anfällt.
Wann ist die Link API nicht der richtige Ansatz?
Die Link API ist primär für die serverseitige Integration mit BAS-IP Link gedacht.
Wenn die Anforderung besteht, direkt mit bestimmten Geräten zu arbeiten oder spezifische Ereignisse direkt von einer Türstation zu empfangen, kann die BAS-IP Device API besser geeignet sein. Die Dokumentation zur Geräteintegration ist über das öffentliche BAS-IP-Entwicklerportal verfügbar.
Wenn eine Organisation bereits eine eigene mobile App besitzt und Türrufe, Video und Türöffnung in diese App integrieren möchte, ist das BAS-IP Mobile SDK für diesen Anwendungsfall konzipiert.
Und dort, wo standardmäßige Interoperabilität über SIP, RTSP oder Wiegand ausreichend ist, ist möglicherweise überhaupt keine maßgeschneiderte Softwareintegration erforderlich.
Die verschiedenen Ansätze werden in „Integration der BAS-IP IP-Türkommunikation in bestehende Gebäudesysteme“ ausführlicher behandelt.
Häufig gestellte Fragen
Ist die BAS-IP Link API eine REST-API?
Ja. Die BAS-IP Link API ist eine HTTP-REST-API, die es einem serverseitigen Drittsystem ermöglicht, programmgesteuert mit BAS-IP Link zu interagieren.
Benötige ich BAS-IP Link, um die Link API zu verwenden?
Ja. Die Link API ist die Programmierschnittstelle für die BAS-IP Link-Plattform.
Funktioniert die BAS-IP Link API mit der Link Cloud?
Zum Zeitpunkt der Veröffentlichung werden serverseitige Drittanbieter-Integrationen über die Link API auf BAS-IP Link Self-Hosted unterstützt. BAS-IP entwickelt ein separates API-Gateway für die Link Cloud.
Wie erhalte ich die Dokumentation, und ist eine NDA erforderlich?
Zuerst wird der Integrations-Anwendungsfall vereinbart. Anschließend unterzeichnet der Partner eine NDA und erhält die relevanten technischen Materialien zur Link API.
Was ist der Unterschied zwischen der Link API und dem Mobile SDK?
Die Link API ist für die serverseitige Integration mit BAS-IP Link vorgesehen, einschließlich Benutzern, Standorten, Zugriffsrechten und anderen Entitäten der zentralisierten Plattform.
Das BAS-IP Mobile SDK dient einem anderen Zweck: dem Hinzufügen von Türkommunikationsfunktionen direkt zu einer bestehenden mobilen Anwendung.
Beide können bei Bedarf im selben Projekt eingesetzt werden.
Möchten Sie Ihre Plattform mit BAS-IP Link integrieren?
Sie müssen vor dem ersten Gespräch keine detaillierte API-Spezifikation vorbereiten.
Beginnen Sie damit, das System zu beschreiben, das Sie bereits haben, und den Prozess, den Sie automatisieren möchten.
Zum Beispiel:
„Wir legen Bewohner in unserer eigenen Plattform an und möchten, dass sie automatisch in BAS-IP übertragen werden.“
oder:
„Wir verwalten den Besucherzugang in unserem eigenen System und möchten diesen Prozess mit BAS-IP verbinden.“
Das BAS-IP-Team kann Ihnen dabei helfen, festzustellen, ob die Link API der richtige Ansatz ist, welche Plattformfunktionen erforderlich sind und wie die Integration strukturiert sein sollte.