Over de ClearID API

2024-08-26Laatst bijgewerkt

De Genetec ClearID™ API is een Application Programming Interface waarmee ontwikkelaars klanten en partners kunnen helpen bij het integreren van aanvullende software of het uitvoeren van aangepaste functies.

Genetec ClearID™ is een API-first service en de webinterface is bovenop die REST API gebouwd. Als gevolg hiervan is het grootste deel van de functionaliteit van de webinterface toegankelijk met behulp van REST-eindpunten (Representational State Transfer).
De ClearID API is ontwikkeld met twee hoofddoelen:
Onafhankelijkheid van het platform
Elke client moet de API kunnen aanroepen, ongeacht hoe de API intern is geïmplementeerd. Deze platformonafhankelijkheid vereist standaardprotocollen en een mechanisme waarmee de client en de webservice het eens kunnen worden over de gegevensindeling die moet worden uitgewisseld.
Evolutie van de service
De web-API moet onafhankelijk van clientapplicaties kunnen ontwikkelen en functionaliteit kunnen toevoegen. Naarmate de API zich verder ontwikkelt, moeten bestaande clienttoepassingen ongewijzigd blijven functioneren.

De ClearID API volgt de beste praktijken voor Representational State Transfer (REST) en gebruikt de standaard HTTP-acties: GET, POST, PUT, PATCH en DELETE.

Voorbeelden

De REST API wordt voornamelijk gebruikt voor het synchroniseren van identiteiten. Er zijn echter ook veel andere scenario's mogelijk.

Hier volgen enkele voorbeelden van de rapporten of gegevens die u kunt ophalen bij ClearID met behulp van de REST API:
  • Lijst met alle aankomende en eerdere bezoekgebeurtenissen.
  • Lijst met alle goedgekeurde gastheren voor bezoekers.
  • Lijst met alle aankomende en eerdere bezoekgebeurtenissen voor een specifieke aanvrager, host of site.
  • Lijst met alle actieve of inactieve hosts, toestemmingsinformatie voor elke host, contactgegevens, titel, afdeling en bedrijf.
Voor elk bezoek kunt u ook het volgende verkrijgen:
  • Gebeurtenis
  • Gebeurtenisnaam
  • Verwachte aankomst- en vertrekdatum en -tijd
  • Aanvrager van een bezoek
  • Lijst van gasten
  • Type bezoek
  • Parkeerlocatie
  • Ontmoetingslocatie
  • Site bezocht
  • Gebieden op die site
  • Details van de goedkeuring

Voor meer informatie over het automatiseren van functies met behulp van de ClearID REST API raadpleegt u de documentatie voor Genetec-ontwikkelaars™ .