API Jitterbit-Variablen in Integration Studio
Einführung
Auf dieser Seite werden die für benutzerdefinierte Jitterbit APIs verfügbaren Jitterbit-Variablen behandelt, organisiert nach den von Ihnen gelesenen Informationsvariablen (Informational) und Einstellungsvariablen, die Sie schreiben (Einstellungen).
Variablen, die mit einem Sternchen (*) enden, kennzeichnen, dass das Sternchen durch einen anderen Wert ersetzt werden soll. Dies ist in der Dokumentation für jede Variable mit einem Sternchen (*) beschrieben.
Hinweis
Für Jitterbit-Variablen mit einem Bindestrich im Namen verwenden Sie die Get Und Set Funktionen zum Abrufen und Festlegen ihrer Werte. Beispiel: Get('jitterbit.target.http.response.header.X-Jitterbit-Authorization').
Ausführliche Informationen zur Verwendung von benutzerdefinierten Jitterbit-APIs finden Sie unter API-Manager.
Informativ
jitterbit.api.request.body Und jitterbit.api.request.body.*
Datentyp
Zeichenfolge
Beschreibung
Betrachtet die an die API übermittelte(n) Payload (en). Beachten Sie, dass für die meisten APIs nur eine einfache Payload erwartet wird. jitterbit.api.request.bodyist die zu verwendende Variable (auch bekannt als content-type:text/plain).
Wenn Sie erwarten, dass mehrere Nutzdaten gleichzeitig übermittelt werden, verwenden Sie das URL-codierte 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.namewird gleich sein EStore wenn der Wert des Formularfeldes "Name" eingegeben wurde als EStore.
jitterbit.api.request.enum.body
Datentyp
Zeichenfolge
Beschreibung
Variables Array, das verwendet wird, um alle übermittelten Teile der Payload/des Hauptteils dynamisch zu durchlaufen (anstatt einen bestimmten Teil zu prüfen, 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
Variables Array, das verwendet wird, um dynamisch durch alle Anforderungsheader zu iterieren (anstatt einen bestimmten Header zu überprü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
Variablen-Array zur dynamischen Iteration aller mehrwertigen Parameter (anstatt jeden Parameter einzeln zu prüfen). jitterbit.api.request.mvparameters.ProdID).
jitterbit.api.request.enum.parameters
Datentyp
Zeichenfolge
Beschreibung
Variablen-Array zur dynamischen Iteration aller übermittelten Parameter (anstatt jeden Parameter einzeln zu prüfen). jitterbit.api.request.parameters.name).
Dieses Script hängt alle bereitgestellten Parameter an eine neue Variable an, um sie dem Benutzer später wieder 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 Anfrage 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. Informationen dazu, welche Header Schlüssel gesendet werden, finden Sie in der OpenAPI-Dokumentation im API-Manager Portal und Portal Manager Seiten.
Wichtig
Wenn der Header-Schlüssel einen Bindestrich enthält (-) im Namen müssen Sie das verwenden.Get Funktion, um den Wert abzurufen. Verweisen Sie nicht mit einem Dollarzeichen]($).
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.namewird gleich sein EStore wenn die angeforderte URL &name=EStore.
Notiz
Mehrwertige URL Parameter geben eine Zeichenfolge zurück, die durch ||| (3 Pipes). Um mehrwertige URL Parameter als Array zurückzugeben, verwenden Sie die jitterbit.api.request.mvparameters.* Variable stattdessen.
Wenn die URL beispielsweise https://jitterbitxx.na.jitterbit.org/dev/ProductAPIResponse?ProdID=abc&ProdID=abc1&ProdID=abc2, Dann jitterbit.api.request.parameters.ProdID wird sein abc|||abc1|||abc2.
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 mehrmals verwendet werden, muss aber für jede Verwendung festgelegt werden.
Trinkgeld
Die jitterbit.api.response Variable kann in einer Variable gesetzt und verwendet werden Endpoint, auf den in denselben oder nachlegende Operationen verwiesen werden soll.
jitterbit.api.response.blank_error_response
Datentyp
Boolescher Wert
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) Für den zurückgegebenen Statuscode wird eine HTML-Statusseite gerendert. Verfügbar für Agent- und API Gateway-Versionen ab 10.59.
jitterbit.api.response.headers.*
Datentyp
Zeichenfolge
Beschreibung
Wird verwendet, um die Antwortheader der API festzulegen. Beispiel: 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, den HTTP-Antwortcode für benutzerdefinierte APIs mithilfe einer Jitterbit Script zu überschreiben. Legen Sie die jitterbit.api.response.status_code Variable im Script, das 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.