Der folgende Abschnitt zeigt, wie Sie in yunIO erstellte Services testen, integrieren und Parameter übergeben können.

Service Testen #

Vor der Integration eines yunIO-Services empfiehlt es sich, den Service direkt in yunIO oder in einem REST-Client Ihrer Wahl zu testen.

  • Klicken Sie auf copy um die URL des Service-Eendpunkts in Ihre Zwischenablage zu kopieren.
    Die URL kann zum Triggern eines Service-Laufs verwendet werden.
  • Klicken Sie auf copy, um Run Service Menu zu öffnen.
    Hier können Sie Parameter definieren und den Service direkt in yunIO ausführen.
    yunIO-Services

Service Menü Ausführen

Führen Sie die folgenden Schritte aus, um einen Service zu testen:

  1. Wenn Globale Zugriffskontrolle - Global Access Control und / oder Service-Zugriffskontrolle - Service Access Control aktiviert ist, geben Sie gültige Anmeldeinformationen ein (1).
  2. Wenn der Service Eingabeparameter erfordert, geben Sie Werte für die unter Service parameters (2) aufgeführten Parameter ein. Das dargestellte Beispiel verwendet einen Eingabeparameter NAME1.
    Run-Service
  3. Klicken Sie auf [Run]. Das Response-Body (Antworttext) des Service wird unter Output Parameters(3) angezeigt.
    Wenn der Service mehrere Elemente zurückgibt, erweitern Sie die Elemente, um den Inhalt anzuzeigen, oder verwenden Sie die Kontrollschaltflächen, um die Anzeige der Parameter anzupassen.
    Wenn das Response-Body eine Fehlermeldung zurückgibt, klicken Sie auf [Logs], um die Logs des Service-Laufs zu öffnen.
  4. Klicken Sie auf [Close], um das Run Service Menü zu schließen.

Tipp: Klicken Sie auf [Edit], um den Service zu bearbeiten oder Parameter hinzuzufügen.

Kontrollschaltfächen

Die Kontrollschaltflächen im Menü „Run Service“ passen die Anzeige der Ein-und Ausgabeparameter an.

  • [Collapse] - klappt alle Parameterelemente zusammen.
  • [Expand] - erweitert alle Parameterelemente.
  • [Maximize] - zeigt die Parameter in einer Vollbildansicht an. Um die Vollbildansichtzu schließen, klicken Sie auf [Close].
  • [JSON] - zeigt die Parameter im JSON-Format an.
  • [To top] - scrollt zum Anfang der Parameterliste.
  • [Reset] - Entfernt alle definierten Eingabeparameter. Diese Option ist nur für Eingabeparameter verfügbar.

Integration eines Services #

Mit yunIO erstellte Webservices können in alle Cloud-Anwendungen integriert werden, die REST API/Swagger (OpenAPI) unterstützen, z.B. Power Automate, Nintex usw.

  • Klicken Sie auf copy, um die URL der Service-Definition in Ihre Zwischenablage zu kopieren.
    Die Servicedefinitions-URL kann von Drittanbieter-Tools verwendet werden, um die Metadaten des Service zu laden.
  • Klicken Sie auf download um die Service-Definition herunterzuladen.
    Die Service-Definition wird als JSON-Datei gespeichert, die definiert wie der Service ausgeführt wird. Die JSON-Datei kann in Drittanbieter-Tools impotiert werden.
    yunIO-Services

Beispiele für die Integration von yunIO-Services in Drittanbieter-Tools:

Für mehr Integrationszenarien und Beispiele, siehe Integrationszenarien.

Übergabe von Parametern #

Welche Parameter an einen YunIO-Service übergeben werden, hängt von der http-Methode ab, die zum Aufrufen des Services verwendet wird.
yunIO unterstützt die http-Methoden POST und GET, siehe POST vs GET.

POST Method

Parameter werden im Anforderungstext eines Services aufgelistet.
Bearbeiten Sie den Anforderungstext, um den Parametern Werte zuzuweisen. Das dargestellte Beispiel verwendet einen Eingabeparameter NAME1:
yunIO-HTTP-POST

GET Method

Parameter stehen als Abfrageparameter in der Service-URL zur Verfügung.
Verwenden Sie Abfrageparameter, um Werte zuzuweisen, oder fügen Sie die Werte direkt in der Service-URL hinzu. Das dargestellte Beispiel verwendet einen Eingabeparameter NAME1:
yunIO-HTTP-GET

Hinweis: Wenn URL-Parameter andere Zeichen enthalten als A–Z a–z 0–9 - _ . ! ~ * ' ( ), verwenden Sie für diese Zeichen eine Escape-Sequenz. Nicht zulässige Zeichen sind z.B. # % &.

POST vs GET #

yunIO-Services unterstützen die http-Methoden „POST“ und „GET“.

  POST GET
Datenlänge Keine Einschränkungen. Die maximale URL-Länge beträgt 2048 Zeichen.
Parameter Parameter sind Teil des HTTP-Anfragetexts. Unterstützt Abfrageparameter in der URL.
Datensicherheit Parameter werden nicht im Browserverlauf oder in Webserverprotokollen gespeichert. Parameter sind in der Service-URL sichtbar. Daten werden zwischengespeichert.
Datentypen Keine Einschränkungen. Unterstützt nur ASCII-Zeichen.

Empfehlung: Wir empfehlen die Verwendung der POST-Methode mit Transport Layer Security (HTTPS), um den Datenschutz zu gewährleisten. Verwenden Sie die GET-Methode nicht zum Senden sensibler Daten, z. B. Referenzen.

Bei Verwendung der OpenAPI/Swagger-Definition sind sowohl „POST“ als auch „GET“ verfügbar. Wählen Sie die Methode aus, die Sie verwenden möchten:
yunIO-HTTP-POST-GET