API Connector für Jitterbit Integration Studio

Zusammenfassung

Der API Connector stellt eine Operation oder eine Reihe von Operationen als nutzbaren REST- Endpoint bereit. Er wird mit einer vorkonfigurierten Verbindung geliefert, für die keine Verbindungskonfiguration erforderlich ist, wie dies bei den meisten Harmony Konnektoren üblich ist. Diese Verbindung bietet Zugriff auf API Aktivitäten, die nach der Konfiguration mit benutzerdefinierten APIs interagieren konfiguriert im Jitterbit API-Manager.

Der Zugriff auf den API Konnektor erfolgt über die Tab Endpoints und -konnektoren der Designkomponentenpalette (siehe Komponentenpalette).

Informationen zur Beziehung zwischen API Connector-Aktivitäten und API-Manager APIs finden Sie in diesen Ressourcen:

• API-Manager API -Typen

• Custom API Konfiguration

• Erstellen einer einfachen benutzerdefinierten API

Wichtig

Standardmäßig werden erfolgreiche API -Operationen (konfiguriert für benutzerdefinierte APIs oder OData-Dienste) sind nicht in den Operation enthalten, sofern nicht eine dieser Einstellungen aktiviert ist:

Cloud-Agenten: Für API Operationen auf einem Cloud-Agenten Operation debuggen muss für die Operation aktiviert sein.

Private Agenten: Für API Operationen auf einem privaten Agenten muss entweder Operation debuggen muss für die Operation aktiviert sein oder Sie müssen EnableLogging=true im [APIoperation] Abschnitt der privaten Agentenkonfigurationsdatei.

Connector-Übersicht

Dieser Connector ist für die Verwendung in Verbindung mit einer benutzerdefinierten API-Manager API vorgesehen, um eine Operation oder eine Reihe von Operationen als nutzbaren REST- Endpoint verfügbar zu machen.

Aktivitätstypen werden zum Erstellen von Instanzen von Aktivitäten verwendet, die als Quellen (zum Bereitstellen von Daten in einem Operation) oder Ziele (zum Verwenden von Daten in einem Operation) verwendet werden sollen.

Die vorkonfigurierte API Verbindung und ihre Aktivitäten werden zusammen als API Endpoint bezeichnet:

• Anfrage: Diese Aktivität wird mithilfe eines JSON-, XML-, CSV- oder XSD Schema konfiguriert und ruft Daten ab, wenn sie von einer benutzerdefinierten API-Manager API aufgerufen wird und soll als Quelle zur Bereitstellung von Daten für einen Operation verwendet werden.

• Antwort: Diese Aktivität wird mithilfe eines JSON-, XML-, CSV- oder XSD Schema konfiguriert und gibt Daten an eine benutzerdefinierte API-Manager API zurück und soll als Ziel zum Verbrauchen von Daten in einer Operation verwendet werden.

• SOAP -Anfrage: Diese Aktivität wird mithilfe eines WSDL- Schema konfiguriert und ruft Daten ab, wenn sie von einer benutzerdefinierten API-Manager API aufgerufen wird und soll als Quelle zur Bereitstellung von Daten für einen Operation verwendet werden.

• SOAP -Antwort: Diese Aktivität wird mithilfe eines WSDL- Schema konfiguriert und gibt Daten an eine benutzerdefinierte API-Manager API zurück und soll als Ziel zum Verbrauchen von Daten in einer Operation verwendet werden.

Hinweis

Dieser Connector ist ein nativer Integration Studio Connector, auf den Jitterbit verweisen kann, wenn Änderungen an Connectoren kommuniziert werden. Der Release-Zeitplan für native Integration Studio Connectors basieren auf der Kadenz der Harmony Portal-Webanwendungen.

API Jitterbit-Variablen

Diese Jitterbit-Variablen sind speziell für die Verwendung mit API Endpoints vorgesehen:

• jitterbit.api.request.body Und jitterbit.api.request.body.*

• jitterbit.api.request.enum.body

• jitterbit.api.request.enum.headers

• jitterbit.api.request.enum.mvparameters

• jitterbit.api.request.enum.parameters

• jitterbit.api.request.headers.*

• jitterbit.api.request.headers.fulluri

• jitterbit.api.request.method

• jitterbit.api.request.mvparameters.*

• jitterbit.api.request.parameters.*

• jitterbit.api.response

• jitterbit.api.response.headers.*

• jitterbit.api.response.status_code

Fehlerbehebung

Wenn Sie Probleme mit dem API Connector haben, werden die folgenden Schritte zur Fehlerbehebung empfohlen:

1. Stellen Sie sicher, dass die API Verbindung erfolgreich ist, indem Sie im Konfigurationsbildschirm auf die Schaltfläche Test klicken. Wenn die Verbindung nicht erfolgreich ist, kann der zurückgegebene Fehler einen Hinweis auf das Problem geben.

2. Überprüfen Sie die Operation für alle Informationen, die während der Ausführung der Operation geschrieben werden.

3. Aktivieren Sie die debuggen für Operation (für Cloud-Agenten oder für private Vertreter), um zusätzliche Protokolldateien und Daten zu generieren.

4. Wenn Sie private Agenten verwenden, können Sie die Agentenprotokolle überprüfen für weitere Informationen.

5. Weitere Hinweise zur Fehlerbehebung finden Sie unter Fehlerbehebung beim Betrieb.

6. SOAP -Anfrage und SOAP -Antwortaktivitäten: Beim Bereitstellen eines Operation, dessen WSDL-Datei der Aktivität SOAP Anforderung oder SOAP Antwort ersetzt wurde, erhalten Sie möglicherweise diesen Fehler:

   Failed to deploy - Client Error: There is no uploaded file with client path ... Upgrade to the 8.4.0 Studio or higher and deploy the project again.

   Um das Problem zu beheben, befolgen Sie diese Schritte:

   1. Öffnen Sie die Aktivität, in der die WSDL-Datei ersetzt wurde.

   2. Wählen Sie in Schritt 1 erneut die für die Aktivität zu verwendende WSDL-Datei aus und klicken Sie dann auf Weiter.

   3. Klicken Sie in Schritt 2 auf Fertig.

   4. Führen Sie die Operation durch.