Informationen über die ClearID API

2024-08-26Zuletzt aktualisiert

Die Genetec ClearID™ API ist eine Anwendungsprogrammierschnittstelle, die Entwickler nutzen können, um Kunden und Partner bei der Integration zusätzlicher Software oder bei der Ausführung benutzerdefinierter Funktionen zu unterstützen.

Genetec ClearID™ ist ein API-First-Service. Die Weboberfläche baut auf dieser REST-API auf. Daher kann auf die meisten Funktionen der Webschnittstelle mithilfe von REST-Endpunkten (Representational State Transfer) zugegriffen werden.
Die ClearID API wurde mit zwei Hauptzielen entwickelt:
Plattformunabhängigkeit
Jeder Client sollte in der Lage sein, die API aufzurufen, unabhängig davon, wie die API intern implementiert ist. Diese Plattformunabhängigkeit erfordert Standardprotokolle und einen Mechanismus, bei dem sich Client und Webservice auf das auszutauschende Datenformat einigen können.
Weiterentwicklung der Services
Die Web-API sollte in der Lage sein, sich unabhängig von Clientanwendungen weiterzuentwickeln und Funktionen hinzuzufügen. Im Zuge der Weiterentwicklung der API sollten vorhandene Clientanwendungen weiterhin ohne Änderungen funktionieren.

Die ClearID-API folgt den optimalen Vorgehensweisen für Representational State Transfer (REST) und verwendet die HTTP-Standardaktionen: GET, POST, PUT, PATCH und DELETE.

Beispiele

Die REST-API wird in erster Linie zum Synchronisieren von Identitäten verwendet. Es sind aber auch viele andere Szenarien möglich.

Hier sind einige Beispiele für Berichte oder Daten, die Sie von ClearID mithilfe der REST-API abrufen können:
  • Liste aller bevorstehenden und vergangenen Besuchsereignisse.
  • Liste aller zugelassenen Besucher-Gastgeber.
  • Liste aller anstehenden und vergangenen Besuchsereignisse für einen bestimmten Anfragesteller, Gastgeber oder Standort.
  • Liste aller aktiven oder inaktiven Hosts, Berechtigungsinformationen für jeden Gastegeber, Kontaktdaten, Titel, Abteilung und Unternehmen.
Für jeden Besuch können Sie auch Folgendes erhalten:
  • Ereignis
  • Name des Ereignisses
  • Voraussichtliches Ankunfts- und Abreisedatum und -zeit
  • Anfragesteller für Besuche
  • Liste der Gäste
  • Art des Besuchs
  • Parkplatzstandort
  • Treffpunkt
  • Besuchter Standort
  • Bereiche auf diesen Standort
  • Details zur Genehmigung

Weitere Informationen über die Automatisierung von Funktionen mit der ClearID REST API finden Sie in der Genetec™ Developer-Dokumentation.