On a single site, the management team may work in a property management platform, the security team in an access control system, and residents in a separate mobile app. If the door entry (intercom) system remains another isolated part of the building, the same users, access rights and events have to be managed in several places.

BAS-IP can be integrated into the building’s existing digital infrastructure. The property management platform can remain the main operational interface for staff, while the existing resident app can gain intercom, video and door release functionality.

There are four main approaches: interoperability through standard protocols, BAS-IP Link API, BAS-IP Mobile SDK and BAS-IP Device API. The right choice depends on what needs to be integrated and how the existing system works.

What is BAS-IP Link?

BAS-IP Link is a software platform for managing connected BAS-IP devices, sites and flats, users, access credentials, calls and device configuration.

It is available in two deployment models: Link Self-Hosted, installed on the customer’s own server infrastructure, and Link Cloud, provided as a BAS-IP cloud service.

Some integrations work through Link, while others communicate directly with BAS-IP equipment.

Interoperability through standard protocols

Not every integration requires software development.

BAS-IP equipment supports standard protocols already widely used across telephony, CCTV and access control systems:

• SIP — the entrance panel registers as a SIP client on the customer’s PBX, allowing calls to be delivered to existing handsets and softphones;
• RTSP — the panel can be added to a VMS or NVR as a video source alongside the other CCTV cameras on site;
• Wiegand — the reader built into the panel can pass a credential identifier to a third-party access control system.

These scenarios are configured at both ends and do not require development against a BAS-IP API or SDK.

Note. For SIP integrations, audio and video codec compatibility between the third-party system and the specific BAS-IP equipment should be checked in advance. For example, BAS-IP equipment supports scenarios using PCMA for audio and H.264 for video. The currently supported codec set should always be checked for the relevant model and firmware version.

Standard protocols can carry a call, video stream or credential identifier, but they do not understand who the user is, which flat they belong to or what access rights they should have.

Where the integration needs to work with the data itself — creating users, granting or revoking access, or retrieving events — an API or SDK is required.

BAS-IP Link API: integration with a property management or server-side platform

Link API is designed for cases where a third-party system needs to interact programmatically with BAS-IP Link: for example, a property management platform, access control system or another enterprise platform already in use on the site.

A straightforward example is a resident move-in.

A member of staff creates the resident’s profile in the existing platform: name, flat and contact details. Without an integration, the same user then has to be created manually for a second time in the intercom system.

With Link API, the data can be transferred automatically. The user is created in the correct site and flat within BAS-IP Link, from where the information can be applied to the connected BAS-IP infrastructure.

That is only one possible use case.

Through Link API, a third-party system can work with:

• users and site structure;
• access rights;
• permanent access credentials, including cards, fobs, PIN codes, QR codes, Face ID, UKEY and vehicle registration numbers;
• temporary credentials with a defined validity period;
• guest access and visitors;
• resident messaging;
• virtual numbers and call forwarding;
• remote device configuration;
• events and logs.

The exact functionality used depends on the requirements of the project.

With this architecture, the customer’s existing platform can remain the day-to-day operational interface for its staff.

Current status. Third-party server-side integrations through Link API are currently implemented on BAS-IP Link Self-Hosted.

Support for BAS-IP Link Cloud is in development and will be provided through an API gateway.

If the project is intended to use Link Cloud, the required use case and available options should be discussed with BAS-IP before development begins.

BAS-IP Mobile SDK: intercom functionality inside your own mobile app

The second common scenario is an organisation that already has its own mobile app for residents, tenants or employees.

That app may already handle maintenance requests, payments, amenity bookings and notifications. Introducing a separate app purely for door entry may therefore be unnecessary.

BAS-IP Mobile SDK adds key intercom, door entry and access functions to the existing application through BAS-IP Link, including:

• user authentication;
• incoming and outgoing audio and video calls;
• live video preview from the entrance panel before answering a call;
• push notifications;
• door release;
• call history;
• BLE-based mobile access through the UKEY component;
• calling the lift to the resident’s floor.

Both iOS and Android are supported.

The resident can answer a call from the entrance panel directly in the app they already use, see a live preview of the visitor before answering, and release the door.

The development team does not need to build the intercom calling layer from scratch. The SIP communication and interaction with BAS-IP Link are already handled by the supplied components; the partner’s role is to integrate those components into its own application.

The Mobile SDK does not reproduce every feature available in the BAS-IP Link application. It provides a defined set of ready-made capabilities.

If a required function is not included in the SDK — for example, generating guest QR codes — the partner can implement it in its own app using direct Link API calls.

Current status. Mobile SDK integrations are implemented on BAS-IP Link Self-Hosted.

Projects requiring BAS-IP Link Cloud should be planned after the Cloud API gateway becomes available.

BAS-IP Device API: direct integration with equipment

Not every integration requires BAS-IP Link.

BAS-IP entrance panels, indoor monitors and other supported devices, including the lift module, have their own local APIs. A third-party system can therefore communicate directly with the equipment.

The distinction is straightforward:

Device API connects your system directly to specific BAS-IP devices.

Link API connects your system to BAS-IP Link, which in turn manages the connected BAS-IP equipment.

Direct device integration is well suited to a local project with a limited and known range of device models.

Integration through Link is generally more suitable where the solution covers different models, a larger number of devices or multiple sites, because Link reduces the integration’s dependence on the specifics of individual device models and firmware versions.

Getting access to the Device API is more straightforward: the documentation is publicly available and no NDA is required.

Developers can register through the BAS-IP developer portal at developers.bas-ip.com and confirm their email address.

Webhooks

Android-based BAS-IP entrance panels also support webhooks.

This allows a third-party system to receive events as they happen, including door release, access granted or denied, device updates and other events recorded in the device log.

This is useful in smart building scenarios where another system needs to react immediately to an access event or door release.

Webhooks are configured directly on the entrance panel through the device configuration.

They are not supported on Linux-based panels, indoor monitors or at BAS-IP Link level.

Which integration approach should you choose?

You do not necessarily need to choose the integration method in advance. In most cases, the right approach becomes clear once the existing system and required use case have been described.

What does integration deliver on site?

• Faster initial setup: user data and related parameters can be transferred from the system in which they are already maintained.
• Less duplicate data entry: the same information does not have to be entered repeatedly in different interfaces.
• Unified operational data: intercom, door entry and access events can be brought together with other site information.
• Familiar workflows: staff can continue working in the systems they already know, while residents can use a single application.

The larger the site, user base and number of connected systems, the more noticeable the benefit becomes.

How does an integration project work?

The organisation starts by describing its existing system and the required use case. For example: “We already have a resident app and want residents to answer intercom calls within it.”

BAS-IP helps identify the appropriate integration method and agree the expected result.

For Link API and Mobile SDK, technical materials are provided once the project has been agreed and an NDA has been signed. A separate project containing the required specifications is created for each partner.

Device API documentation is publicly available.

The integration itself is developed by the partner’s team.

BAS-IP answers technical questions relating to its products, helps clarify the integration scenario and assists where an implementation based on the documentation does not behave as expected.

If a project requires functionality that is not currently available in the product, the requirement can be discussed with the BAS-IP product team. The scope of the work and its place in the development plan are assessed first. Such an assessment does not constitute a commitment to a specific release date.

Test environment and hardware arrangements are agreed for each individual project.

The completed solution is tested by the partner. Once development is finished, the partner demonstrates the result to BAS-IP or provides a description of the completed integration.

For a typical integration, around one month of focused development time can be used as a broad guide.

The overall calendar duration is usually longer, depending on the partner team’s availability and the time required to become familiar with the system.

How much does integration cost?

BAS-IP does not normally charge a separate fee for access to integration documentation and tools.

BAS-IP products continue to be licensed under their standard licensing terms.

Any additional product development or requests to change the priority of such work are agreed separately.

Frequently asked questions

What is the difference between Link API and Mobile SDK?

Link API connects BAS-IP with a server-side system such as a property management platform or access control system. Mobile SDK adds BAS-IP intercom and door entry functionality to a mobile application. Both can be used together within the same project.

Is BAS-IP Link required for every integration?

No. Many BAS-IP devices have their own local API, so a third-party system can communicate with the equipment directly. Link is generally more useful where an integration needs to cover different device models, a large number of devices or multiple sites.

Is an NDA required?

An NDA is required for Link API and Mobile SDK. Device API documentation is publicly available.

Are webhooks supported?

Yes, on Android-based entrance panels. A third-party system can receive device events in real time. Webhooks are not available on Linux-based panels, indoor monitors or at BAS-IP Link level.

Can a third-party platform be integrated with BAS-IP Link Cloud?

Third-party server-side integrations through Link API are currently implemented on Link Self-Hosted. Equivalent functionality for Link Cloud is in development.

How many developers are required?

For Link API, a back-end or full-stack developer will normally be required. For Mobile SDK, a mobile developer is required. Larger integrations may also require DevOps expertise.

Want to integrate BAS-IP with your system?

Tell us which platform, application or equipment you already use and what you want the integration to achieve.

The BAS-IP team can help identify the most suitable approach: standard protocol interoperability, Link API, Mobile SDK, Device API, or a combination of these.