API Jitterbit-Variablen in Design Studio

Einführung

Auf dieser Seite finden Sie Informationen zu Jitterbit-Variablen, die für benutzerdefinierte Jitterbit APIs verfügbar sind, sortiert nach den von Ihnen gelesenen Informationsvariablen (Informational) und Einstellungsvariablen, die Sie schreiben (Einstellungen).

Variablen, die mit einem Asterisk (*) enden, bedeuten, dass der Asterisk durch einen Header-Namen ersetzt werden soll, wie in jitterbit.target.http.response.header.X-Jitterbit-Authorization.

Informativ

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

Datentyp

Zeichenfolge

Beschreibung

Betrachtet die Payload/Nutzlasten, die an die API übermittelt werden. Beachten Sie, dass Sie für die Mehrheit der APIs nur eine einfache Payload erwarten würden und daher jitterbit.api.request.body ist die zu verwendende Variable (auch bekannt als content-type:text/plain).

Wenn Sie mehrere Payloads auf einmal übermitteln möchten, verwenden Sie das URL-kodierte Formular (auch bekannt als content-type:application/x-www-form-urlencoded), wie im Fall einer API, die als Backend eines Übermittlungsformulars verwendet wird (siehe http://www.w3.org/TR/html401/interact/forms.html), dann sollten Sie jitterbit.api.request.body.*. Wie bei jitterbit.api.request.parameters.*, jitterbit.api.request.body.name wird gleich sein EStore wenn der Wert des Formularfeldes "Name" eingegeben wurde als EStore.

jitterbit.api.request.enum.body

Datentyp

Zeichenfolge

Beschreibung

Variables Array, das zum dynamischen Durchlaufen aller übermittelten Teile der Payload/des Hauptteils verwendet wird (im Gegensatz zur Überprüfung eines bestimmten Teils wie bei jitterbit.api.request.body.*). Die Verwendung ist die gleiche wie bei der jitterbit.api.request.enum.parameters.

jitterbit.api.request.enum.headers

Datentyp

Zeichenfolge

Beschreibung

Variablen-Array zum dynamischen Durchlaufen aller Anforderungsheader (anstatt bestimmte Header zu prüfen wie bei jitterbit.api.request.headers.*). Die Verwendung ist die gleiche wie bei der jitterbit.api.request.enum.parameters Und jitterbit.api.request.enum.body.

jitterbit.api.request.enum.mvparameters

Datentyp

Zeichenfolge

Beschreibung

Variablenarray, das zum dynamischen Durchlaufen aller mehrwertigen Parameter verwendet wird (anstatt jeden Parameter einzeln zu prüfen, da jitterbit.api.request.mvparameters.ProdID).

jitterbit.api.request.enum.parameters

Datentyp

Zeichenfolge

Beschreibung

Variablen-Array, das zum dynamischen Durchlaufen aller übermittelten Parameter verwendet wird (anstatt jeden Parameter einzeln zu prüfen, da jitterbit.api.request.parameters.name).

Dieses Script hängt alle angegebenen Parameter an eine neue Variable an, um sie später dem Benutzer anzuzeigen:

<trans>
$output = "URL Parameters: <br>\r\n";
enum = $jitterbit.api.request.enum.parameters;
i = 0;
while(i<length(enum),
  name = enum[i];
  $output = $output + "$" + name + ": " + Get(name) + " <br>\r\n";
  i = i+1;
 );
if(i==0, $output = $output + "(none)<br>\r\n");
</trans>

jitterbit.api.request.headers.*

Datentyp

Zeichenfolge

Beschreibung

Diese Jitterbit-Variable gibt den Wert des angegebenen Header zurück, der in der API Anforderung gesendet wird. Das Sternchen (*) muss durch den Schlüssel der Header ersetzt werden.

Beispielsweise kann die Variable jitterbit.api.request.headers.x_forwarded_for Gibt die öffentliche IP der Box/des Benutzers zurück, der auf die URL zugreift.

Beide Standardheader in RFC 9110 und benutzerdefinierte Header werden unterstützt. Um festzustellen, welche Header Schlüssel gesendet werden, lesen Sie die OpenAPI-Dokumentation über den API-Manager Portal und Portal Manager Seiten.

Beispiele

// Returns the value of the Content-Type header
Get('jitterbit.api.request.headers.Content-Type')

// Returns the value of the x_forwarded_for header
Get('jitterbit.api.request.headers.x_forwarded_for')

// Returns the value of the x_forwarded_for header
$jitterbit.api.request.headers.x_forwarded_for

// Returns the value of the my-custom-key header
Get('jitterbit.api.request.headers.my-custom-key')

// Returns the value of the My_Custom_Key header
Get('jitterbit.api.request.headers.My_Custom_Key')

// Returns the value of the My_Custom_Key header
$jitterbit.api.request.headers.My_Custom_Key

jitterbit.api.request.headers.fulluri

Datentyp

Zeichenfolge

Beschreibung

Die URL, die aufgerufen wurde, um Jitterbit OData oder die benutzerdefinierte API auszulösen.

jitterbit.api.request.method

Datentyp

Zeichenfolge

Beschreibung

Die Anforderungsmethode, die zum Aufrufen der API verwendet wurde.

jitterbit.api.request.mvparameters.*

Datentyp

Zeichenfolge

Beschreibung

Betrachtet die Mehrfachwerte des Parameters, der direkt über die URL an die API übermittelt wurde, und gibt die Werte als Array mit einem Leerzeichen zwischen den einzelnen Werten zurück.

Wenn die URL beispielsweise https://jitterbitxx.na.jitterbit.org/dev/ProductAPIResponse?ProdID=abc&ProdID=abc1&ProdID=abc2, Dann jitterbit.api.request.mvparameters.ProdID wird sein abc abc1 abc2.

jitterbit.api.request.parameters.*

Datentyp

Zeichenfolge

Beschreibung

Betrachtet die Parameter, die direkt über die URL an die API übermittelt werden. Beispiel: jitterbit.api.request.parameters.name wird gleich sein EStore wenn die angeforderte URL &name=EStore.

Einstellungen

jitterbit.api.response

Datentyp

Zeichenfolge

Beschreibung

Diese Variable muss festgelegt werden, wenn Ihre benutzerdefinierte API ist so konfiguriert, dass eine Systemvariable als Antworttyp verwendet wird. Der jitterbit.api.response Die Variable kann in einer Operation mehrfach verwendet werden, muss aber für jede Verwendung neu festgelegt werden.

jitterbit.api.response.blank_error_response

Datentyp

Boolesch

Beschreibung

Ermöglicht die Rückgabe einer leeren API -Antwort für Nicht-200-Typ Statuscodes wenn jitterbit.api.response.blank_error_response ist eingestellt auf true Wenn eingestellt auf false (Standard) wird für den zurückgegebenen Statuscode eine HTML-Statusseite gerendert. Verfügbar für die Verwendung mit Agent- und API Gateway-Versionen 10.59 oder höher.

jitterbit.api.response.headers.*

Datentyp

Zeichenfolge

Beschreibung

Wird verwendet, um die Antwortheader der API festzulegen. Legen Sie beispielsweise fest jitterbit.api.response.headers.access_control_allow_origin="*" um das standardmäßige CORS-Verhalten außer Kraft zu setzen und den standortübergreifenden Zugriff auf die API von jeder Domäne aus zu ermöglichen.

jitterbit.api.response.status_code

Datentyp

Zeichenfolge

Beschreibung

Bietet die Möglichkeit, HTTP-Antwortcode für benutzerdefinierte APIs über die Jitterbit Script zu überschreiben. Legen Sie die jitterbit.api.response.status_code Variable im Script, die von einer benutzerdefinierten API ausgeführt wird. Dadurch können Projektautoren einen bestimmten HTTP-Fehlercode (zusammen mit den tatsächlichen Payload ) festlegen, anstatt sich darauf zu verlassen, dass das System basierend auf dem Standardverhalten die Codes 200 oder 500 zurückgibt.