API BAS-IP Link : Comment intégrer l’interphonie et le contrôle d’accès

Un nouveau résident est d’abord configuré dans le système que l’équipe de gestion utilise déjà pour les appartements, les résidents et les coordonnées. Ensuite, la même personne est recréée, cette fois dans le système d’interphonie (contrôle d’accès). Les droits d’accès changent : deux systèmes doivent être mis à jour. Le résident déménage : le dossier doit être supprimé deux fois.

Sur un seul site, ce n’est qu’une charge administrative supplémentaire. Sur un portefeuille immobilier avec des emménagements réguliers, des changements d’accès et des laissez-passer temporaires, cela devient un processus de gestion distinct dont personne ne voulait au départ.

Qu’est-ce que BAS-IP Link et Link API ?

BAS-IP Link est la plateforme centralisée de BAS-IP pour la gestion des sites, des utilisateurs, des droits d’accès et de l’infrastructure connectée.

BAS-IP Link API est une API HTTP REST qui permet à un système serveur tiers d’interagir avec Link de manière programmatique : transmettre des données d’utilisateurs, gérer les droits d’accès et les identifiants, et récupérer des données de la plateforme.

L’objectif n’est pas de donner au personnel un autre système avec lequel travailler. Bien au contraire : la plateforme existante du client peut rester l’interface opérationnelle principale, tandis que BAS-IP s’intègre aux processus qui y sont déjà gérés.

Comment cela se présente-t-il en pratique ? Ajouter un nouveau résident

La société de gestion connaît déjà le nom du résident, son appartement, ses coordonnées et d’autres informations pertinentes. Ces données existent déjà dans son propre système.

Sans intégration, un membre du personnel doit alors ouvrir BAS-IP Link et créer à nouveau le même utilisateur.

Avec Link API, cette deuxième étape peut être automatisée. Le système principal transmet les données requises à Link, l’utilisateur est placé dans le site et l’appartement appropriés, et BAS-IP Link travaille ensuite avec l’infrastructure d’interphonie et d’accès connectée.

La valeur pratique n’est pas simplement que deux systèmes peuvent échanger des données. C’est que le personnel n’a pas à changer sa façon de travailler actuelle.

Si les emménagements, les modifications des détails des résidents et les déménagements sont déjà gérés dans la plateforme principale, les mêmes actions n’ont pas besoin d’être répétées manuellement dans le système d’interphonie.

Pourquoi utiliser Link API alors que les appareils BAS-IP ont leur propre API ?

BAS-IP prend également en charge l’intégration directe avec l’équipement via BAS-IP Device API.

Pour un projet local, cela peut être la bonne approche. Si un système doit fonctionner avec un ou plusieurs modèles d’appareils connus et ne nécessite qu’un ensemble limité de fonctions, une couche de serveur supplémentaire peut ne pas être nécessaire.

Le besoin change à mesure que le projet évolue.

Différents bâtiments peuvent utiliser différentes platines de rue, des moniteurs intérieurs et d’autres appareils. De nouveaux modèles et versions de micrologiciels sont introduits au fil du temps. Avec une intégration directe des appareils, l’équipe de développement tierce doit tenir compte des caractéristiques de l’équipement avec lequel elle s’intègre.

BAS-IP Link ajoute une couche logicielle centralisée entre la plateforme tierce et l’infrastructure d’interphonie.

Au lieu de construire sa logique métier autour d’une platine de rue particulière, la plateforme externe travaille avec le modèle central de Link comprenant les utilisateurs, les sites, les appartements, les droits d’accès et d’autres entités.

C’est généralement un modèle plus naturel pour une plateforme de gestion de propriétés résidentielles. Elle n’a généralement pas besoin de savoir quelle platine de rue exacte est installée à une porte particulière. Elle doit savoir qu’un résident particulier appartient à un appartement particulier et doit avoir accès aux zones appropriées.

BAS-IP Link connecte cette logique métier avec l’infrastructure physique d’interphonie et de contrôle d’accès.

Que pouvez-vous faire via BAS-IP Link API ?

Une intégration particulière n’utilisera normalement qu’une partie des fonctionnalités disponibles dans Link.

Via l’API, un système tiers peut travailler avec :

• les utilisateurs et la structure du site ;
• les droits d’accès ;
• les identifiants d’accès permanents et temporaires, y compris les cartes, les badges, les codes PIN, les codes QR, Face ID, UKEY et les numéros d’immatriculation des véhicules ;
• l’accès des invités et les visiteurs ;
• les messages et les sondages ;
• les numéros virtuels et le transfert d’appels ;
• la configuration des appareils à distance ;
• les événements et les journaux.

Cependant, un projet d’intégration est généralement mieux défini par une question différente de « Quelles méthodes API sont disponibles ? ».

Quelles tâches sont effectuées manuellement aujourd’hui, et lesquelles devraient se produire automatiquement une fois les systèmes intégrés ?

Pour une plateforme, le cas d’utilisation principal peut être la gestion des résidents. Pour une autre, il peut s’agir de l’accès temporaire des entrepreneurs. Une troisième peut principalement avoir besoin de données d’événements.

Gérer l’ensemble du cycle de vie de l’utilisateur, pas seulement sa création

Créer un utilisateur n’est que la première étape.

Une fois qu’un résident a été ajouté, les droits d’accès et les identifiants appropriés peuvent être attribués. Si le résident déménage dans un autre appartement, change de véhicule, reçoit des autorisations supplémentaires ou perd son accès, ces changements peuvent également faire partie du flux de travail dans la plateforme principale.

Le même principe s’applique aux utilisateurs temporaires.

Si un système existant gère déjà les visiteurs, les entrepreneurs ou le personnel de service, il n’est pas nécessaire de créer un processus administratif distinct uniquement pour BAS-IP.

Par exemple, la plateforme principale peut déterminer qu’un entrepreneur devrait pouvoir entrer dans un bâtiment le mardi entre 10h00 et 14h00. Dans ce scénario, BAS-IP devient la couche d’accès qui exécute un processus déjà défini ailleurs.

L’interphonie et le contrôle d’accès font donc partie du modèle de fonctionnement global du bâtiment plutôt que d’être un système séparé qui doit être administré indépendamment.

Et si le site est déjà actif et possède une vaste base d’utilisateurs ?

Une intégration ne commence pas nécessairement avec une base de données vide.

Si un système existant contient déjà des centaines ou des milliers de résidents, ils n’ont pas besoin d’être saisis manuellement dans BAS-IP Link un par un.

Lors de l’utilisation de BAS-IP Link API, la méthode de création d’utilisateurs peut ajouter plusieurs utilisateurs en une seule requête.

Un nombre maximum garanti d’enregistrements par opération et la fréquence autorisée des requêtes consécutives ne sont pas actuellement spécifiés. Pour une migration à grande échelle, ces paramètres doivent donc être validés dans l’environnement de test du projet avant de déplacer l’ensemble de la base d’utilisateurs.

Les détails de mise en œuvre de la méthode API sont fournis aux partenaires d’intégration dans la documentation technique.

Il existe également une option intégrée pour la création en masse d’utilisateurs sans développer d’intégration API.

BAS-IP Link peut exporter la structure du site vers un fichier XLS. Les détails de l’utilisateur et de la licence sont ensuite complétés dans la feuille de calcul et importés dans Link. Une fois importés, les utilisateurs sont automatiquement affectés aux groupes de sites spécifiés. Lorsque plusieurs utilisateurs appartiennent au même appartement ou à un autre groupe de site, des lignes distinctes peuvent utiliser le même identifiant de groupe.

Pour un déploiement résidentiel initial, il n’est pas nécessaire de collecter une adresse e-mail pour chaque membre du foyer. Une adresse e-mail par appartement est suffisante : l’utilisateur invité reçoit un e-mail, termine l’inscription et peut ensuite ajouter lui-même les membres de sa famille.

Pour un développement existant, l’équipe de projet peut donc choisir entre une migration API automatisée et le processus de téléchargement en masse intégré de Link, en fonction de l’architecture du système et de l’emplacement de la base de données d’utilisateurs source.

Les événements BAS-IP peuvent-ils être utilisés dans un autre système ?

Oui. Les données et événements conservés dans Link peuvent être utilisés par un système tiers.

Par exemple, une équipe de sécurité peut déjà travailler à partir d’une interface unique qui rassemble les informations du contrôle d’accès, de la vidéosurveillance et d’autres systèmes du bâtiment. Les données BAS-IP peuvent faire partie du même flux de travail opérationnel.

Il y a cependant une distinction technique importante.

BAS-IP Link ne fournit pas actuellement de webhooks pour pousser des événements vers des systèmes tiers. Le système externe récupère les données requises en effectuant des requêtes à Link API.

Si un projet nécessite que des événements particuliers soient livrés directement à partir de l’équipement via des webhooks, ce scénario est disponible sur les platines de rue Android compatibles via BAS-IP Device API.

Un projet peut donc combiner une intégration centralisée via Link avec une interaction directe avec des appareils sélectionnés si nécessaire.

Quel système devrait être la source de vérité ?

L’une des décisions clés dans une intégration est de savoir quel système est responsable de chaque type de données.

Si le même utilisateur peut être modifié indépendamment à la fois dans la plateforme de gestion immobilière et dans BAS-IP Link, les enregistrements peuvent finir par devenir incohérents.

Par exemple, la plateforme de gestion immobilière peut rester responsable des résidents et des appartements, BAS-IP Link peut appliquer ces informations à l’interphonie et au contrôle d’accès, tandis qu’une plateforme de sécurité distincte consomme les données d’événements nécessaires aux opérateurs.

Un autre projet peut diviser les responsabilités différemment.

Le point important n’est pas que BAS-IP, ou la plateforme tierce, doive toujours être le système « maître ». C’est que la source de référence pour chaque entité et la direction de la synchronisation doivent être clairement définies.

C’est ce qui supprime l’administration en double plutôt que de simplement connecter deux bases de données.

Où Link API est-il le plus utile ?

Link API est particulièrement pertinent lorsque BAS-IP doit faire partie d’un écosystème logiciel existant.

Les exemples typiques incluent :

• les plateformes de gestion de propriétés résidentielles et de domaines ;
• les grands systèmes de contrôle d’accès ;
• les BMS (systèmes de gestion de bâtiment) et les plateformes de bâtiments intelligents ;
• les produits PropTech ;
• les propres plateformes logicielles des intégrateurs ;
• les plateformes gérant plusieurs bâtiments ou sites.

Plus un projet compte d’utilisateurs, de bâtiments et de modifications d’accès régulières, plus l’administration est dupliquée lorsque les systèmes restent séparés.

La valeur de Link API n’est donc généralement pas définie par le nombre de méthodes API disponibles, mais par le nombre de processus opérationnels distincts qui peuvent être regroupés.

Sécurité et autorisations d’intégration

Un système tiers n’a pas besoin d’un accès administratif illimité à Link.

Dans BAS-IP Link Self-Hosted, un compte d’intégration dédié peut être créé et ses autorisations limitées à la fois par fonction et par site individuel.

Par exemple, une intégration utilisée par un opérateur immobilier particulier peut être limitée aux bâtiments gérés par cette organisation.

L’authentification utilise des jetons d’accès et la communication API s’effectue via HTTPS.

Le flux d’authentification détaillé et les structures de requête sont couverts dans la documentation technique de Link API.

BAS-IP Link Self-Hosted et Link Cloud

Au moment de la publication, les intégrations côté serveur tiers via BAS-IP Link API sont prises en charge sur BAS-IP Link Self-Hosted.

BAS-IP développe une passerelle API distincte pour BAS-IP Link Cloud.

Si un projet nécessite spécifiquement une intégration tierce avec Link Cloud, l’architecture proposée doit donc être discutée avec BAS-IP avant le début du développement.

Comment démarrer une intégration

Un projet Link API commence par le cas d’utilisation plutôt que par une liste d’appels API.

Par exemple :

« Lorsque nous créons un résident dans notre plateforme, nous voulons que l’utilisateur soit créé automatiquement dans le bon site BAS-IP. »

C’est suffisant pour entamer une discussion architecturale.

Une fois le scénario d’intégration convenu, le partenaire signe un NDA (accord de non-divulgation) et reçoit les documents techniques pertinents.

L’intégration elle-même est normalement développée par l’équipe du partenaire. Un projet typique nécessitera généralement un développeur back-end ou full-stack. Les déploiements plus importants peuvent également nécessiter une expertise DevOps.

Pour le développement et les tests, BAS-IP Link Self-Hosted peut être déployé dans le propre environnement du partenaire. Il n’y a actuellement aucun bac à sable (sandbox) public partagé pour Link API. La licence de test et les dispositions matérielles sont convenues en fonction des exigences du projet individuel.

BAS-IP fournit la documentation, répond aux questions techniques relatives à ses propres produits et aide à enquêter sur les cas où une implémentation basée sur la documentation ne se comporte pas comme prévu.

Si un projet nécessite des fonctionnalités qui ne sont pas actuellement disponibles dans le produit, le besoin peut être discuté avec l’équipe produit. Le travail impliqué et sa place dans le plan de développement sont évalués en premier. Une telle évaluation ne constitue pas en soi un engagement pour une date de sortie particulière.

Combien de temps prend une intégration Link API ?

Il n’y a pas d’échelle de temps unique qui s’applique à chaque projet.

Pour une intégration relativement standard, environ un mois de développement ciblé peut être utilisé comme guide général, bien que la durée calendaire soit souvent plus longue.

L’équipe de développement du partenaire a besoin de temps pour comprendre le modèle de données Link, mettre en œuvre sa partie de l’intégration, la tester et intégrer le travail dans son propre calendrier de développement.

Une estimation significative ne peut donc être faite qu’une fois le scénario d’intégration réel défini.

Y a-t-il des frais supplémentaires pour BAS-IP Link API ?

BAS-IP ne facture normalement pas de frais distincts pour l’accès à la documentation et aux outils d’intégration.

BAS-IP Link lui-même est concédé sous licence selon le modèle de licence de produit standard. Le partenaire développe son propre côté de l’intégration, tandis que les travaux de développement BAS-IP non standard ou les demandes de modification de la priorité de ces travaux peuvent être discutés séparément le cas échéant.

Pour cette raison, décrire l’intégration elle-même comme « gratuite » peut être trompeur.

Une affirmation plus exacte est qu’il n’y a normalement pas de frais distincts pour l’accès aux outils d’intégration BAS-IP.

Quand Link API n’est-il pas la bonne approche ?

Link API est principalement destiné à une intégration côté serveur avec BAS-IP Link.

Si l’exigence est de travailler directement avec un équipement spécifique, ou de recevoir des événements particuliers directement à partir d’une platine de rue, BAS-IP Device API peut être plus approprié. La documentation d’intégration des appareils est disponible via le portail des développeurs public de BAS-IP.

Si une organisation dispose déjà de sa propre application mobile et souhaite ajouter des appels d’interphonie, de la vidéo et le déverrouillage de la porte au sein de cette application, BAS-IP Mobile SDK est conçu pour ce cas d’utilisation.

Et lorsque l’interopérabilité standard via SIP, RTSP ou Wiegand est suffisante, une intégration logicielle sur mesure peut ne pas être requise du tout.

Les différentes approches sont couvertes plus en détail dans « Intégration de l’interphonie IP BAS-IP avec les systèmes de bâtiment existants ».

Foire aux questions

BAS-IP Link API est-elle une API REST ?

Oui. BAS-IP Link API est une API HTTP REST qui permet à un système serveur tiers d’interagir de manière programmatique avec BAS-IP Link.

Ai-je besoin de BAS-IP Link pour utiliser Link API ?

Oui. Link API est l’interface de programmation pour la plateforme BAS-IP Link.

BAS-IP Link API fonctionne-t-elle avec Link Cloud ?

Au moment de la publication, les intégrations côté serveur tiers via Link API sont prises en charge sur BAS-IP Link Self-Hosted. BAS-IP développe une passerelle API distincte pour Link Cloud.

Comment obtenir la documentation, et un NDA est-il requis ?

Le cas d’utilisation de l’intégration est convenu en premier. Le partenaire signe ensuite un NDA et reçoit les documents techniques pertinents de Link API.

Quelle est la différence entre Link API et Mobile SDK ?

Link API est destiné à l’intégration côté serveur avec BAS-IP Link, y compris les utilisateurs, les sites, les droits d’accès et d’autres entités de la plateforme centralisée.

BAS-IP Mobile SDK sert un objectif différent : ajouter des fonctionnalités d’interphonie directement à une application mobile existante.

Les deux peuvent être utilisés dans le même projet le cas échéant.

Vous souhaitez intégrer votre plateforme avec BAS-IP Link ?

Vous n’avez pas besoin de préparer une spécification API détaillée avant la première discussion.

Commencez par décrire le système que vous avez déjà et le processus que vous souhaitez automatiser.

Par exemple :

« Nous créons des résidents dans notre propre plateforme et nous voulons qu’ils soient transférés automatiquement dans BAS-IP. »

ou :

« Nous gérons l’accès des visiteurs dans notre propre système et nous voulons connecter ce processus à BAS-IP. »

L’équipe BAS-IP peut vous aider à déterminer si Link API est la bonne approche, quelles capacités de la plateforme seront nécessaires et comment l’intégration doit être structurée.