> For the complete documentation index, see [llms.txt](https://docs.openwowi.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openwowi.de/grundlagen/einrichtung-openwowi.md).

# Einrichtung OPENWOWI

Auf dieser Seite beschreiben wir die Einrichtung von OPENWOWI im WOWIPORT.

## WOWIPORT-Konfiguration

{% hint style="warning" %}
Um auf die OPENWOWI-Konfiguration zugreifen zu können, wird das Benutzerrecht "OPEN WOWI Konfiguration" benötigt.
{% endhint %}

In dem Menüpunkt "Schnittstellen" unter *Systemverwaltung* >> *Schnittstellen* >> *OPENWOWI Konfiguration* (siehe Screenshot) in WOWIPORT erhalten Sie eine Übersicht über bereits eingerichtete Schnittstellen und können neue Schnittstellen hinzufügen.

\
![](https://619896158-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfOXt8VHk6GRwZ0LymzOn%2Fuploads%2FuqYWVrrYkEm0MFo035wl%2Fimage.png?alt=media\&token=c983b0df-0cba-40dc-8233-2d7d17455a2d)

## Details der Konfiguration

Durch das Anlegen der Konfiguration wird ein individueller API-Key zur Nutzung der Schnittstelle für eine Anwendung erzeugt. Über die Endpunktberechtigungen können Sie steuern, über welche der verschiedenen API-Endpunkte eine Datenausgabe möglich sein soll.

Alle Datenabrufe funktionieren nur in den konfigurierten Buchwerken. Datenabrufe werden auf die Buchwerksauswahl gefiltert.

<div data-full-width="true"><figure><img src="https://619896158-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfOXt8VHk6GRwZ0LymzOn%2Fuploads%2Fe7KHZU6S0m09ks5g3KHW%2Fimage.png?alt=media&amp;token=13377199-ec08-4db7-8ad6-4ed1a4eee638" alt=""><figcaption><p>API Key Konfiguration</p></figcaption></figure></div>

Um unsere Beispiele zur Nutzung der API nachvollziehen zu können, können Sie einen Zugang zu unserer Sandbox beantragen. Bitte kontaktieren Sie hierfür [Partnermanagement@drklein-wowi.de](mailto:partnermanagement@drklein-wowi.de).\
Sie erhalten dann einen technischen User und einen API Key. Für die Beantragung **benötigen wir eine E-Mailadresse** (diese wird für die Passwortvergabe an den Benutzer gebunden) für die Versendung der Einladung zu unserer Sandbox und Zustellung des API Keys.

Die URL der Sandbox lautet:

<https://openwowi-demo.wowiport.de/>

Weiterführende Informationen zur Berechtigungssteuerung finden Sie in den Abschnitten "[Authentifizierung und Berechtigungen](https://docs.openwowi.de/schnittstelle-v1.x/authentifizierung-und-berechtigungen.md)" in der Schnittstellendokumentation.

Details zur Einrichtung von [Webhooks](https://docs.openwowi.de/grundlagen/webhooks.md) und der Quelleneinstellungen für das [Kommunikationsmodul](https://docs.openwowi.de/schnittstelle-v1.x/kommunikationsmodul.md) finden Sie in den jeweiligen Abschnitten.

Details zur Freischaltung von Dokumentenabrufen und der Einrichtung des Tabs für externe DMS Systeme finden Sie im Abschnitt "[Dokumente und Medien](https://docs.openwowi.de/schnittstelle-v1.x/dokumente-und-medien.md)".

## Nutzung der Endpunkte

Für die Nutzung der Endpunkte müssen Sie eine Route ansprechen, welche sich aus der Basis-URL und der Endpunkt-URL zusammensetzt. Die Basis-URL ist hierbei die URL der Kundeninstanz (<https://kundenname.wowiport.de>). \
Die Endpunkt-URL finden Sie in den einzelnen Abschnitten der Dokumentation.

Beispiel:\
![](https://619896158-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfOXt8VHk6GRwZ0LymzOn%2Fuploads%2FmpGJmnj54bgibAxE6UT3%2Fimage.png?alt=media\&token=cf865f74-d9fa-43f0-b4ad-c37a5afd1612)
