Vizito hat eine REST-API, über die Ihre eigenen Systeme Besucherdaten lesen und schreiben können. Die vollständige Dokumentation dazu liegt auf einer eigenen Seite: developers.vizito.eu.
Was steht auf dem Entwicklerportal?
- Schnellstart: von keinem Zugangsmittel bis zur ersten Besucherliste in wenigen Minuten.
- Grundbegriffe: die wenigen Objekte, auf denen die ganze API aufbaut, und wie Standorte, Besuche und Besuchstypen zusammenhängen.
- API-Referenz: jeder Endpunkt, nach Ressource geordnet. Besucher, registrierte Besucher, Gastgeber, Besuchstypen, Eingänge, Vereinbarungen, Geräte, Auswertungen und WebHooks, jeweils mit Parametern, Beispielanfrage und Beispielantwort.
- Anleitungen: Besucher aus dem eigenen System an- und abmelden, Besucher vorab registrieren und Einladungen versenden, Gastgeber mit dem eigenen Verzeichnis abgleichen und WebHooks empfangen.
Was brauche ich vor dem ersten Aufruf?
Einen API-Schlüssel. Nur globale Administratoren können einen anlegen, auf der Integrationsseite im Backoffice. Wie Sie einen erstellen, einschränken und widerrufen, und wie Sie sich stattdessen mit einer Microsoft-Entra-ID-Anwendung authentifizieren, steht unter API-Zugang und API-Schlüssel.
Die Basis-URL, die für jeden Endpunkt geltenden Konventionen (IDs, Datumsangaben, benutzerdefinierte Felder, Sprachen) und die Bedeutung jedes Fehlercodes finden Sie auf der Seite Introduction.
Gibt es eine OpenAPI-Spezifikation?
Ja. Die Spezifikation ist unter vizito.eu/openapi.yaml veröffentlicht. Damit können Sie einen Client generieren, die API in Postman oder Insomnia importieren oder Ihre eigenen Werkzeuge darauf ansetzen.
Kann Vizito uns benachrichtigen, statt dass wir die API abfragen?
Ja, über einen WebHook. Vizito ruft Ihren Endpunkt in dem Moment auf, in dem etwas passiert, Sie müssen also nicht wiederholt nachfragen, ob sich etwas geändert hat. Zur Einrichtung siehe WebHooks in diesem Hilfecenter, und für die Nutzdaten und Ereignisse die Webhooks-Anleitung auf dem Entwicklerportal.
Wen können wir zur API fragen?
Wenn etwas in der Dokumentation unklar ist oder sich ein Endpunkt anders verhält als beschrieben, kontaktieren Sie uns. Nennen Sie dabei den Endpunkt, die gesendete Anfrage und die Antwort, die Sie zurückbekommen haben.