REST- API Tutorial für Jitterbit Design Studio
Harmony kann verwendet werden, um jeden RESTful-Webdienst zu nutzen, auch bekannt als REST API. Da REST- APIs HTTP-basiert sind, stellen Sie eine Verbindung zu ihnen über eine HTTP-Quelle her oder HTTP-Ziel in Jitterbit Design Studio. REST- APIs sind nicht zu verwechseln mit Webdiensten, die eine SOAP API verwenden, für die eine Harmony Webdienstmethode wird stattdessen verwendet.
Dieses Tutorial zeigt anhand eines vollständigen Beispiels, wie Sie REST- APIs in Harmony mit Atlassian Jira nutzen als Endpoint zu Demonstrationszwecken. Derselbe Prozess kann auf jeden Endpoint angewendet werden, der eine REST- API verwendet. Einige andere Beispiele für REST APIs sind Magento, ServiceNow, Shopify, DocuSign, SharePoint, Epicor, Zendesk, Zoho und Sugar CRM, um nur einige zu nennen.
Die Zielgruppe dieses Tutorials sind Personen, die mit REST- APIs und deren Tests nicht vertraut sind und über Grundkenntnisse in Harmony verfügen. Wenn Sie stattdessen mehr Erfahrung mit einem oder allen dieser Themen haben, empfehlen wir Ihnen, die nachstehende Schrittübersicht nach interessanten Punkten durchzulesen. Das letzte Thema, Verwenden einer REST- API im Operation, ist möglicherweise vor allem für diejenigen interessant, die Erfahrung mit REST APIs, aber weniger Erfahrung mit Harmony haben.
Gliederung des Tutorials
Die folgenden Themen werden in diesem Lernprogramm behandelt und zwar in der Reihenfolge, in der sie abgeschlossen werden sollten:
-
Recherche zu einer REST- API
Es gibt einige spezielle Elemente, nach denen Sie in der Dokumentation einer API suchen sollten, die Sie später benötigen, um die API zu validieren und in der Konfiguration in Design Studio bereitzustellen. Dazu gehört das Einrichten der Art der Authentifizierung, die Harmony zur Authentifizierung mit der API verwenden soll, und das Abrufen von Anforderungs URLs, Anforderungsheadern, Anforderungsstrukturen und erwarteten Antwortstrukturen. -
Validieren einer REST- API
Bevor Sie mit Harmony eine Verbindung zu einer REST- API herstellen, wird dringend empfohlen, Tests und Validierungen mit einem unabhängigen Tool durchzuführen. Auf dieser Seite werden die Tests der Authentifizierung sowie das Validieren und Speichern von Strukturen für jede Anfrage und Antwort Schritt für Schritt beschrieben. -
Verbindung zu einer REST- API herstellen
In Design Studio muss eine HTTP-Quelle oder ein HTTP-Ziel für die entsprechende HTTP-Methode Ihrer Anfrage (GET, PUT, POST, DELETE oder benutzerdefinierte Methode) konfiguriert werden, damit Sie sie als Operation verwenden können. Während sich diese Seite auf allgemeine Konfigurationsoptionen konzentriert, sind die Seiten HTTP-Quelle und HTTP-Ziel bieten ausführlichere Informationen zu allen Optionen, die konfiguriert werden können. -
Verwenden einer REST- API im Operation
Obwohl jede REST- API den gleichen architektonischen Einschränkungen unterliegt, sind sie nicht alle für jede HTTP-Methode gleich konzipiert. Da jede spezifische Anfrage und Antwort von der spezifischen API abhängt, stellen wir vier Entwurfsmuster für den Entwurf von Operationen vor:-
Nur eine Antwortstruktur
Dieses Muster gilt für Methoden, bei denen Sie nur eine Antwortstruktur und keine Anforderungsstruktur bereitstellen müssen. Dies ist normalerweise bei GET-Methoden der Fall, da Sie normalerweise nur Daten anfordern, die von der API zurückgesendet werden sollen, anstatt der API Daten bereitzustellen. Sie senden zwar immer noch eine Anforderung an die API, aber Ihre Anforderung liegt nicht in Form strukturierter Daten vor. Die Anforderung wird einfach mithilfe der Anforderungs URL und aller Anforderungsheader oder anderer konfigurierbarer Optionen gestellt, die während der HTTP-Quellkonfiguration festgelegt wurden. -
Sowohl Anforderungs- als auch Antwortstrukturen
Dieses Muster gilt für Methoden, bei denen Sie sowohl Anforderungs- als auch Antwortstrukturen bereitstellen. Dies ist häufig bei POST-Methoden der Fall, bei denen Sie die Erstellung von Daten anfordern und dann Informationen darüber zurückerhalten, was erstellt wurde. Die Antwort von der API kann auf beliebige Weise verwendet werden, aber häufig werden die neuen Objekt-IDs in einem späteren Operation verwendet. -
Nur eine Anforderungsstruktur
Dieses Muster gilt für Methoden, bei denen Sie eine Anforderungsstruktur angeben, aber keine strukturierten Daten von der REST- API zurückgegeben werden. Bei APIs, die nur eine Anforderungsstruktur haben, bedeutet dies nicht, dass die API nicht antwortet; es bedeutet, dass die API -Antwort so einfach wie ein Statuscode sein kann. -
Weder eine Bitte noch eine Antwort
Dieses Muster gilt für Methoden, die weder strukturierte Eingabedaten akzeptieren noch strukturierte Ausgabedaten zurückgeben. In solchen Fällen wird die Anforderung normalerweise vollständig mit der URL und den Anforderungsheadern angegeben. Die Antwort ist normalerweise ein Statuscode.
-