Checkliste für die Einrichtung in WOWIPORT

Zur Einrichtung des API-Keys und des Nutzers in WOWIPORT benötigen unsere Kunden einige Informationen. Diese Checkliste soll es unseren Partnern vereinfachen, die notwendigen Informationen abzufragen oder bereitzustellen.

Frage	Benötigt für
Wer soll die Passworthoheit für den technischen Nutzer innehaben?	Um einen neuen Nutzer anzulegen, wird eine E-Mail-Adresse benötigt. Der Empfänger dieser E-Mail hat später die Möglichkeit, das Passwort für die Authentifizierung zu setzen.
Für welchen Knotenpunkt soll der API-Key gelten?	Wenn ein Wohnungsunternehmen in mehrere Subunternehmen aufgeteilt ist, können sich diese auf tieferen Knotenpunkten in der Berechtigungsstruktur wiederfinden.
Für welche Buchwerke soll der API-Key gelten?	Über die Berechtigungsstruktur hinaus lassen sich auch einzelne Buchwerke auswählen, für welche der API-Key gültig sein soll. Diese Einschränkung hat allerdings nur bei buchwerksgebundenen Entitäten eine Auswirkung. Die Auswahl "aller Buchwerke" ist ebenfalls möglich.
Welche API-Berechtigungen benötigt der API-Key?	In den einzelnen Controllern finden Sie, jeweils auf der höchsten Seite der Dokumentation, einen Hinweis auf die für die entsprechenden Endpunkte benötigten API-Berechtigungen.
Muss ein Katalogeintrag für das Kommunikationsmodul angelegt werden?	Das Kommunikationsmodul ist quellengebunden und benötigt einen Eintrag für die Nachrichtenquelle, welche im API-Key an den dort hinterlegten Nutzer gebunden wird.
Ist die Berechtigung für das Kommunikationsmodul bereits in WOWIPORT aktiviert?	Das Kommunikationsmodul ist eine neue Entwicklung innerhalb von WOWIPORT und steht noch nicht allen Nutzern zur Verfügung. Das Modul muss vorab für einen bestimmten Nutzerkreis aktiviert werden.
Wird ein Webhook benötigt?	Soll ein Webhook angelegt werden, muss eine URL angegeben werden. Sollte die URL mit einer Authentifizierungsmethode abgesichert werden, müsste diese ebenfalls kommuniziert werden. Zudem muss natürlich die Entität für den Webhook angegeben werden.
Welche Dokumente sollen freigegeben werden?	Die Dokumente API umfasst viele Module. In der API Key Einrichtung haben wir deshalb die Möglichkeit geschafften, den Zugriff auf bestimmte Dokumentarten und -entitäten einzuschränken. Weitere Informationen finden Sie im Abschnitt "Dokumente".