Einstieg

Informationen

  • In diesem Modul werden Web-Schnittstellen angelegt und konfiguriert.
  • Eine Web-Schnittstelle definiert den Endpunkt, an dem mit PLANTA interagiert werden kann.
  • Pro Methode (GET, PUT, POST, DELETE) können eine Implementation und eine Web-Entität hinterlegt werden.
    • Die Implementation gibt vor, wie sich die Schnittstelle verhalten soll, wenn sie aufgerufen wird.
    • Die Web-Entität beschreibt die Daten, mit denen die Schnittstelle interagiert.
  • Über das Kontextmenü einer Web-Schnittstelle werden mit dem Befehl Web-Entitäten bearbeiten die Web-Entitäten im Modul Web-Entitäten zur Bearbeitung aufgerufen, die mit dieser Web-Schnittstelle konfiguriert wurden.
  • Über die Schaltfläche Log ansehen wird das Modul Requests mit dem Logging der Web-Schnittstelle geöffnet.

Hinweise

  • Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices in der web.conf aktiviert und konfiguriert sein:
  • Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.
  • Web-Schnittstellen verwenden standardmäßig den Fully Qualified Domain Name (FQDN) als Adresse. Ist dieser nicht verfügbar, wird auf den Hostnamen der Maschine zurückgegriffen. Ist dieser nicht verfügbar, wird auf die IP der Maschine zurückgegriffen. Ein expliziter Hostname kann mit der Globalen Einstellung planta_link_hostname definiert werden.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

Siehe auch : Allgemeine Informationen zu Web-Schnittstellen; Web-Schnittstellen-Workflows: GET, PUT, POST, DELETE

Neue Web-Schnittstelle anlegen

Vorgehensweise

  • Neue Web-Schnittstelle einfügen:
    • Über den Kontextmenüeintrag Einfügen → Web-Schnittstelle oder
    • Klick auf den Button Einfügen
  • Felder im Kopfbereich wie folgt ausfüllen:
    • Die Bezeichnung ist frei wählbar
    • Das Feld Aktiv muss aktiviert werden, bevor die Schnittstelle eingesetzt wird.
    • Im Feld Url einen Platzhalter anlegen, beispielsweise: /load/{resource}
    • Das Feld Log-Level gibt je nach Auswahl an, ob und wie detailliert geloggt werden soll.
    • Die gewünschte GET-Implementation (oder PUT, POST, DELETE) auswählen.
    • Die gewünschte Entität auswählen.
      • Nach Auswahl der Entität kann mit einem Klick auf die Schaltfläche der URL-Filter konfiguriert werden.
  • Speichern.
  • Im Feld Authentifizierung die gewünschte Authentifizierungsmethode auswählen. Je nachdem, ob eine Token- oder eine API-Schlüssel-Methode ausgewählt wurde, sind folgende Schritte notwendig: 
    • Für eine Token-Authentifizierung muss entweder ein vorhandener Token der Web-Schnittstelle zugeordnet werden oder ein neuer generiert und zugeordnet werden. Dafür die Schaltfläche Tokens verwalten verwenden, um in das gleichnamige Modul zu wechseln.
    • Für eine API-Schlüssel-Authentifizierung einen API-Schlüssel im gleichnamigen Feld vergeben.
    • Beide Authentifizierungsmöglichkeiten machen nur mit konfiguriertem HTTPS Sinn, da der Schlüssel sonst einfach mitgelesen werden kann.
  • Über die Schaltfläche kann die Schnittstelle im Modul Web-Schnittstellen testen getestet werden.

Bestehende Web-Schnittstelle bearbeiten

Vorgehensweise

  • Maske für Web-Schnittstellen einfügen:
    • Über den Kontextmenüeintrag Einfügen → Web-Schnittstelle oder
    • Klick auf den Button Einfügen
  • In der Listbox UUID die gewünschte Web-Schnittstelle auswählen.
  • Die gewünschten Werte ändern.
  • Speichern.