API-Connector in Jitterbit Studio

Zusammenfassung

Der API-Connector stellt einen Vorgang oder eine Reihe von Vorgängen als verbrauchbaren REST-Endpunkt bereit. Er wird mit einer vorkonfigurierten Verbindung geliefert, die keine Verbindungskonfiguration erfordert, wie sie für die meisten Harmony-Connectors typisch ist. Diese Verbindung bietet Zugriff auf API-Aktivitäten, die nach der Konfiguration mit benutzerdefinierten APIs interagieren, die im Jitterbit API Manager konfiguriert sind.

Der API-Connector wird über die Registerkarte Projektendpunkte und Connectors der Designkomponentenpalette aufgerufen (siehe Designkomponentenpalette).

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

• API Manager-API-Typen

• Konfiguration benutzerdefinierter APIs

• Erstellen einer einfachen benutzerdefinierten API

Connector-Übersicht

Dieser Connector ist zur Verwendung in Verbindung mit einer benutzerdefinierten API des API Managers vorgesehen, um einen Vorgang oder eine Reihe von Vorgängen als verbrauchbaren REST-Endpunkt bereitzustellen.

Aktivitätstypen werden verwendet, um Instanzen von Aktivitäten zu erstellen, die als Quellen (um Daten in einem Vorgang bereitzustellen) oder Ziele (um Daten in einem Vorgang zu verbrauchen) verwendet werden sollen.

Zusammen werden die vorkonfigurierte API-Verbindung und ihre Aktivitäten als API-Endpunkt bezeichnet:

• Anfrage: Diese Aktivität wird mit einem JSON-, XML-, CSV- oder XSD-Schema konfiguriert, ruft Daten ab, wenn sie von einer benutzerdefinierten API des API Managers aufgerufen wird, und ist zur Verwendung als Quelle zum Bereitstellen von Daten für einen Vorgang vorgesehen.

• Antwort: Diese Aktivität wird mit einem JSON-, XML-, CSV- oder XSD-Schema konfiguriert, gibt Daten an eine benutzerdefinierte API des API Managers zurück und ist zur Verwendung als Ziel zum Verbrauchen von Daten in einem Vorgang vorgesehen.

• SOAP-Anfrage: Diese Aktivität wird mit einem WSDL-Schema konfiguriert, ruft Daten ab, wenn sie von einer benutzerdefinierten API des API Managers aufgerufen wird, und ist zur Verwendung als Quelle zum Bereitstellen von Daten für einen Vorgang vorgesehen.

• SOAP-Antwort: Diese Aktivität wird mit einem WSDL-Schema konfiguriert, gibt Daten an eine benutzerdefinierte API des API Managers zurück und ist zur Verwendung als Ziel zum Verbrauchen von Daten in einem Vorgang vorgesehen.

Dieser Connector kann mit Cloud-Agenten und privaten Agenten verwendet werden.

Dieser Connector ist ein nativer Connector: Seine Updates werden zusammen mit der Studio-Anwendung oder dem Agenten veröffentlicht und nicht separat. Siehe Studio-Connector-Updates.

Mit diesem Connector erstellte Endpoints werden von der Endpoint-Nutzungsberichterstellung ausgeschlossen und nicht auf die Lizenzanzahl angerechnet.

API-Jitterbit-Variablen

Diese Jitterbit-Variablen stehen speziell zur Verwendung mit API-Endpoints zur Verfügung:

• 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.headers.content_type

  Hinweis

  Wenn ein Endpoint eine bestimmte Zeichenkodierung erfordert, können jitterbit.source.text.character_encoding und jitterbit.target.text.character_encoding erforderlich sein. Diese müssen zusammen mit allen Variablen, die die API-Antwort beeinflussen, in einem Skript vor jeder Transformation im Vorgang festgelegt werden. Dies umfasst Variablen wie jitterbit.api.response.headers.content_type.

• jitterbit.api.response.status_code

Fehlerbehebung

Bei Problemen mit dem API-Connector werden folgende Schritte zur Fehlerbehebung empfohlen:

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

2. Überprüfen Sie die Vorgangsprotokolle auf Informationen, die während der Ausführung des Vorgangs geschrieben wurden.

3. Aktivieren Sie das Vorgang-Debug-Logging (für Cloud-Agenten oder für private Agenten), um zusätzliche Protokolldateien und Daten zu generieren.

4. Bei Verwendung von privaten Agenten können Sie die Agent-Protokolle auf weitere Informationen überprüfen.

5. Weitere Überlegungen zur Fehlerbehebung finden Sie unter Fehlerbehebung für Vorgänge.

6. SOAP-Anfrage und SOAP-Antwort-Aktivitäten: Wenn Sie einen Vorgang bereitstellen, dessen WSDL-Datei der SOAP-Anfrage- oder SOAP-Antwort-Aktivität ersetzt wurde, erhalten Sie möglicherweise diese Fehlermeldung:

Fehler beim Bereitstellen - Client-Fehler: Es gibt keine hochgeladene Datei mit dem Client-Pfad ... Führen Sie ein Upgrade auf Studio 8.4.0 oder höher durch und stellen Sie das Projekt erneut bereit.

Gehen Sie wie folgt vor, um das Problem zu beheben:

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

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

3. Klicken Sie in Schritt 2 auf Fertig stellen.

4. Stellen Sie den Vorgang bereit.