Visual Planning API-KEY generieren

Visual Planning stellt getrennte Schnittstellen für den Zugriff auf Planungsdaten und für den Zugriff auf die Administration bereit.

Für beide Bereiche werden unterschiedliche API-Schlüssel verwendet. Die Schlüssel sind technisch voneinander getrennt und können nicht gegenseitig verwendet werden.

1. API-Schlüssel für den Zugriff auf eine Planung

Für den Zugriff auf die Daten einer konkreten Visual-Planning-Planung wird ein planungsbezogener API-Schlüssel benötigt.

Öffnen Sie dazu das Visual Planning Admin Center und wählen Sie die gewünschte Planung aus. Klicken Sie mit der rechten Maustaste auf die Planung und wählen Sie „Ändern“.

Im Dialog „Planung“ befindet sich im unteren Bereich der Abschnitt „WebService“. Über das Stiftsymbol öffnen Sie die Liste der für den WebService berechtigten Benutzer.

Fügen Sie über das Plus-Symbol den gewünschten Benutzer hinzu. Visual Planning erzeugt für diesen Benutzer einen Schlüssel für den WebService-Zugriff auf die betreffende Planung.

Über diesen Zugang können – abhängig von den Berechtigungen des verwendeten Benutzers – beispielsweise Vorgänge, Ressourcen, Rubriken und weitere Daten innerhalb dieser Planung gelesen oder verändert werden.

Wichtig: Dieser Schlüssel berechtigt ausschließlich zum Zugriff auf die entsprechende Planung. Er kann nicht für die administrativen API-Funktionen von Visual Planning verwendet werden.
Hinweis: Der API-Key stellt eine Zugangsberechtigung zur Visual-Planning-Schnittstelle dar und sollte entsprechend geschützt behandelt werden. Für produktive Schnittstellen empfiehlt sich grundsätzlich die Verwendung eines eigenen technischen Benutzerprofils mit den tatsächlich benötigten Berechtigungen, anstatt dauerhaft das admin-Profil zu verwenden

2. Admin-API-Key

Für den Zugriff auf administrative Informationen stellt Visual Planning einen separaten Admin-API-Key zur Verfügung.

Die administrative API ermöglicht – abhängig vom jeweiligen Endpunkt – beispielsweise den Zugriff auf:

• Benutzer
• Gruppen
• Lizenzinformationen
• administrative Konfigurationsinformationen

Erstellen des Admin-API-Keys:

Im Admin-Center

und dann

Der Admin-API-Key ermöglicht keinen Zugriff auf Planungsdaten. Mit diesem Schlüssel können insbesondere keine Vorgänge, Ressourcen, Rubriken oder sonstigen Inhalte einer Planung gelesen oder verändert werden.

Eine Anwendung, die sowohl administrative Informationen als auch Daten einer Planung benötigt, muss daher die beiden Schnittstellen getrennt verwenden und benötigt die jeweils dafür vorgesehenen Zugangsdaten.

Übersicht

Hinweis: API-Schlüssel sind Zugangsdaten und sollten entsprechend geschützt behandelt werden. Sie sollten nicht veröffentlicht oder ungeschützt in allgemein zugänglichen Skripten und Konfigurationsdateien hinterlegt werden.