WebServices API
Dank der Möglichkeiten, die das WebServices der Implementierungen SOAP oder REST bietet, ist es nun möglich, von Anwendungen von Drittanbietern aus mit bestimmten Entitäten von „Visual Planning“ zu interagieren.
Diese WebServices bieten Funktionen zum Lesen, Erstellen, Bearbeiten und Löschen von Vorgängen und Ressourcen. Sie können zudem zum Erstellen und Löschen von Verknüpfungen zwischen Vorgängen verwendet werden.
In diesem Dokument bezieht sich „ROOTVP“ auf den Stamm der URL, über die der Zugriff auf den betreffenden „Visual Planning“-Server erfolgt (d. h. vor „/index.jsp“ in der URL, die für den Zugriff auf die Startseite des VP-Servers verwendet wird).
Der Zugriff auf diese WebServices ist durch einen API-Schlüssel geschützt. Dieser Schlüssel ist einem bestimmten Anwender zugeordnet, der im Admin Center ausdrücklich als berechtigt zur Nutzung dieser Dienste deklariert werden muss. Die Deklaration des Anwenders und die Erstellung des API-Schlüssels erfolgen für jeden Planer individuell.
Erstellen eines API-Schlüssels
Durch die Generierung eines Planner-API-Schlüssels wird ein Anwender einem Planer zugeordnet.
Sie erteilt dem Anwender die Berechtigung zum Zugriff auf die Planungsdaten und ermöglicht die Identifizierung des Anwenders, um die Berechtigungen anzuwenden, die der Gruppe gewährt wurden, zu der er gehört.
Um einen API-Schlüssel zu generieren, starten Sie das Admin Center und bearbeiten Sie anschließend die Eigenschaften eines Planers über die Option „Ändern“ in dessen Kontextmenü, um das Bearbeitungsfenster für die Planereigenschaften anzuzeigen.
Klicken Sie in der Rubrik WebService des Edition-Fensters für die Planer-Eigenschaften auf die Schaltfläche „Bearbeiten“ des Feldes „Autorisierte Anwender“.
Klicken Sie auf die Schaltfläche und wählen Sie einen Anwender aus (es können auch mehrere Anwender ausgewählt werden).
Der API-Schlüssel für den Planer wird anschließend generiert und kann verwendet werden
Beispiel:
Authentifizierung erforderlich
Wird diese Option aktiviert, wird der generierte Planungs-API-Schlüssel gelöscht, was bedeutet, dass sich der autorisierte Anwender identifizieren muss, um einen temporären API-Schlüssel zu erhalten.
Diese Identifizierung erfolgt über den GET-Zugriffspunkt /login der REST-API v2. (siehe WEBSERVICES