Integrazioni via API

Integrazioni via API#

IpDoor nasce come sistema aperto: è progettato per integrarsi con moltissimi dispositivi, software e piattaforme di terze parti. Le integrazioni si possono raggruppare in due grandi aree — Locali e Cloud-Cloud — che si differenziano per il "punto" in cui avviene lo scambio dei dati.

Integrazioni Locali#

Le integrazioni locali avvengono sulla rete dell'impianto, direttamente tra il dispositivo IpDoor (la targa) e i sistemi di terze parti presenti in loco. Possono essere di diversi tipi:

  • API REST su rete locale (LAN): la targa dialoga in HTTP (GET/POST/PUT) con un server locale (ad esempio un server di domotica). Esistono profili preimpostati per integrazioni note, oppure si può creare un'integrazione "ad hoc" personalizzando i comandi. Si crea un dispositivo "Integrazione" e lo si configura sui dispositivi.
  • Standard supportati: ad esempio il protocollo SIP per la telefonia/VoIP.
  • Integrazioni "hardware" tramite contatti fisici: chiudendo un contatto (output) si attiva un dispositivo di terze parti; oppure, ricevendo un comando da un dispositivo terzo, si comanda un input (fisico o virtuale) della targa.

Le integrazioni locali sono trattate in dettaglio nella scheda Integrazioni del menu Configurazioni del dispositivo.

Integrazioni Cloud-Cloud#

Le integrazioni Cloud-Cloud avvengono direttamente tra la piattaforma cloud di IpDoor e la piattaforma cloud del partner, senza passare dalla rete locale. Sono molto efficienti e affidabili, ma presuppongono un lavoro di sviluppo che segue le specifiche delle API IpDoor.

Esistono due modalità di integrazione Cloud-Cloud, con natura diversa:

  • Integrazioni native realizzate direttamente da IpDoor con partner specifici. Un esempio è quella con gli ascensori KONE: i due sistemi cloud si parlano e si scambiano i comandi in modo perfettamente integrato (ad esempio la chiamata dell'ascensore al piano corretto al momento dell'accesso). Queste integrazioni sono sviluppate e gestite da IpDoor e non sono realizzabili da integratori esterni.
  • Integrazioni tramite API pubblica che IpDoor mette a disposizione degli integratori di terze parti. Il caso tipico è quello dei PMS (gestionali di prenotazione per hotel e B&B): quando viene creata una prenotazione nel PMS, il codice di accesso — con le relative date e orari di validità — viene inviato automaticamente ai dispositivi, così l'ospite può entrare coerentemente con la prenotazione.

Come funziona l'API Cloud per il controllo accessi#

Per le integrazioni realizzate dagli integratori (come quelle con i PMS), la piattaforma cloud di IpDoor mette a disposizione un'API REST con cui un partner (una "Integration Company") può gestire da remoto i codici di accesso degli appartamenti. In sintesi:

  • Autenticazione: l'accesso alle API avviene tramite OAuth2 (token JWT); il partner riceve le proprie credenziali (client_id / client_secret) e opera con un proprio account sul cloud IpDoor.
  • Ambito: ogni impianto/edificio corrisponde a un "dominio"; gli appartamenti sono rappresentati come utenti "virtuali". Le operazioni si effettuano previo "login" sull'impianto desiderato.
  • Gestione dei codici: si possono creare, leggere e cancellare codici di accesso PIN o QR per ciascun appartamento, con validità temporale (data/ora di inizio e fine), eventuale numero massimo di utilizzi, lunghezza del PIN e generazione di codici intelligenti utilizzabili anche offline.
  • Link di accesso: si può generare un link a una pagina web associato al codice, utile quando il dispositivo non dispone di tastierino o lettore QR.
  • Log di accesso: si possono consultare gli eventi di accesso (ricercabili per codice o per appartamento), con eventuali media associati.
  • Notifica in LAN (opzionale): oltre alla sincronizzazione via internet, si può notificare anche sulla rete locale l'avvenuta aggiunta/cancellazione di un codice, per un aggiornamento immediato dei dispositivi.

Questa sezione è una panoramica funzionale. Il flusso completo — credenziali, autenticazione, login nell'impianto, creazione e cancellazione dei codici, link di accesso, notifica in LAN e lettura dei log — è documentato passo per passo in API Cloud per il controllo accessi, con gli endpoint e i payload di esempio. La documentazione di riferimento endpoint per endpoint resta lo Swagger su api.ipdoor.com.