API Token

Um den automatisierten Austausch von Daten zwischen maXzie und anderen Systemen zu ermöglichen, können sogenannte API Token erstellt werden. Diese Token dienen als Authentifizierungsmethode für den Zugriff auf die von maXzie bereitgestellten API-Endpunkte.

Alle API Token sind an einen bestimmten Mitarbeitenden gebunden und können jederzeit widerrufen werden. Der API Token hat die gleichen Berechtigungen wie der verknüpfte Mitarbeitende. Es ist wichtig, dass diese Token sicher aufbewahrt werden, da sie den Zugriff auf sensible Daten ermöglichen.

Der API Token kann aktuell nur von Superusern unter dem Abschnitt API Token generiert werden. Über den “Plus”-Knopf kann ein neuer Token erstellt werden. Im Dialog müssen ein verknüpfter Mitarbeiter und eine Beschreibung angegeben werden.

Nach der Erstellung wird der Token im nächsten Dialog nur einmal angezeigt, daher sollte er sicher gespeichert werden.

In der Liste der API Token können bestehende Token jederzeit gelöscht werden. Ein gelöschter API Token verliert sofort seine Gültigkeit und kann nicht wiederhergestellt werden. Zudem können die API Token nach der Erstellung auch erneuert werden. Dabei wird ein neuer Token generiert, der alte Token verliert sofort seine Gültigkeit und kann nicht wiederhergestellt werden.

Zum Unterscheiden von unterschiedlichen API Token werden die ersten 4 Zeichen des Tokens in der Liste angezeigt.

Alle mit einem API Token nutzbaren Endpunkte sind in der API Dokumentation beschrieben. Diese kann über das Drei-Punkt Menü im Abschnitt API Token aufgerufen werden.