Erstellen eines Webservice-Endpunkts in edoc automate
Sie können beliebige Webservice-Endpunkte erstellen.
Gut zu wissen
Jeder Webservice-Endpunkt muss einen eindeutigen Namen haben. Geben Sie Ihren Endpunkten “sprechende” Namen.
Die Groß-/Kleinschreibung von Namen wird nicht berücksichtigt.
So geht’s
Klicken Sie in Ihrem App-Projekt in der Seitenleiste auf New Endpoint.
Geben Sie im Dialog Add Web Service Endpoint einen eindeutigen Namen und eine Beschreibung für den neuen Endpunkt ein.
Klicken Sie auf Add, um den Editor des Webservice-Endpunkts zu öffnen.
Konfigurieren Sie im Abschnitt General unter Path, HTTP Methods und Response die Details für den Endpunkt.
Folgende Details müssen Sie für einen Webservice-Endpunkt konfigurieren:
Path > Route: Mit der Route geben Sie an, über welche URL der Endpunkt erreichbar ist. Zusätzlich können Sie auch Parameter über die Route festlegen, sodass der Endpunkt direkt durch die URL gesteuert werden kann.
HTTP Methods: Mit der HTTP-Methode können Sie festlegen, auf welche Anfragen der Endpunkt reagieren soll. Folgende Methoden werden standardmäßig unterstützt:
GET
POST
PUT
DELETE
Response: Legen Sie das Format die Rückgabe des Webservices fest. Folgende Formate werden standardmäßig unterstützt:
Raw: Die Rückgabe der Aktionen wird ohne Anpassungen oder Umwandlung an die aufrufende Client -App gesendet.
JSON: Die Rückgabe der Aktionen wird in JSON umgewandelt.
XML: Die Rückgabe der Aktionen wird in XML umgewandelt.
Sie können mit Plug-Ins auch andere Rückgabeformate implementieren.
Im Abschnitt Actions können Sie beliebige Aktionen im Webservice-Endpunkt erstellen. Bei den Aktionen ist es nicht notwendig, dass ein bestimmtes Element befüllt wird. Sie müssen nur darauf achten, dass die Aktion einen einzelnen Wert oder einen Datensatz zurückgibt. Die Rückgabe der Aktion wird durch das ausgewählte Plug-In bei der Rückgabe verarbeitet.
Im Abschnitt Authentication können Sie festlegen, ob beim Aufrufen des Webservice-Endpunktes eine Authentifizierung und eine Autorisierung abgefragt werden soll. Standardmäßig können Sie folgende Authentifizierungsverfahren verwenden:
Noauth: Es wird keine Authentifizierung abgeprüft.
Basicauth: Es wird auf eine HTTP-Basic-Authentifizierung mit Benutzername und Kennwort geprüft.
Apikey: Es wird auf einen bestimmten Wert in einem festgelegten HTTP-Header geprüft.
Wenn die Authentifizierung fehlschlägt, wird eine entsprechende Fehlermeldung ausgegeben.
Sie können die Parameter der Authentifizierungsverfahren für die Rückgabe von Aktionen verwenden. Sie müssen zu diesem Zweck zu jedem Parameter, der Aktionen unterstützt, mit Add Action eine Aktion erstellen.
Sie finden den neuen Webservice-Endpunkt in der Seitenleiste im Abschnitt Web Service Endpoints. Sie können den Endpunkt direkt bearbeiten, indem Sie auf den Endpunkt klicken, um den Editor zu öffnen.
Sie können mehrere Endpunkte gleichzeitig öffnen und in der Navigationsleiste der App zwischen den Endpunkten hin und her wechseln.
Siehe auch