CallEndpoint

CallEndpoint ruft HTTP auf.

In der folgenden Tabelle sind die Parameter für die Aktion CallEndpoint aufgeführt.

Tabelle 1. CallEndpoint -Aktionsparameter
Ihren Namen	Datentyp	Beziehung	Erforderlich	Hinweise
Methode	Aufzählung	Attribut	Ja	Mögliche Werte: ERLANGEN POST PUT LÖSCHEN PATCH
url	Zeichenfolge	Attribut	Ja	URL des Endpunkts (ohne Abfrageparameter).
savePath	Zeichenfolge	Attribut	Nein	Die Antwort wird als JSON-Objekt im folgenden Format gespeichert: `/response { status_code: 200, status_message: "OK", headers: { "Date": "Tue, 16 Jun 2020 17:31:29 GMT", "Content-Type": "application/json", }, body: ... }` Wenn Sie keinen savePath -Wert angeben, wird die Endpunktantwort nicht an einer Standardposition gespeichert. Wenn Sie die Antwort speichern möchten, muss ein Wert für savePath angegeben werden.
sslConfiguration	SSL-Konfiguration	Unterelement	Nein	Weitere Informationen finden Sie unter SSLConfiguration.
Authentifizierung	Authentifizierung	Unterelement	Nein	Ein Authentifizierungsobjekt muss einen der folgenden Typen aufweisen: BasicAuthentication BearerAuthentication DigestAuthentication Neu in V2 Akamai EdgeGrid -Authentifizierung Neu in V2 Hawk-Authentifizierung
queryParameters	QueryParameter	Unterelement	Nein	Sie können mehrere Abfrageparameter haben. Weitere Informationen finden Sie unter QueryParameter.
requestHeaders	RequestHeaders	Unterelement	Nein	Sie können mehrere Anforderungsheader haben. Weitere Informationen finden Sie unter RequestHeader.
requestCookie	RequestCookie	Unterelement	Nein	Neu in V2_1 Sie können mehr als ein Anfrage-Cookie haben. Für weitere Informationen siehe RequestCookie
Text	RequestBody UrlEncodedFormRequestBody XmlRequestBody	Unterelement	Nein	Der Hauptteil muss einen der folgenden Typen aufweisen: RequestBody UrlEncodedFormRequestBody XmlRequestBody

In der folgenden Tabelle sind die Parameter für SSLConfiguration aufgeführt.

Tabelle 2. SSLConfiguration, Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Protokoll	Zeichenfolge	Nein	Das zu verwendende SSL-Protokoll. Der Standardwert ist TLSv1.2.
allowUntrustedServerCertificate	boolesch	Nein	Gibt an, ob nicht vertrauenswürdige Serverzertifikate zulässig sind. Die Standardeinstellung ist 'False'.

XML-Beispiel

Dieses Beispiel lässt ein nicht vertrauenswürdiges Serverzertifikat zu.

<SSLConfiguration allowUntrustedServerCertificate="true" />

Die folgende Tabelle enthält die Parameter für BasicAuthentication.

Tabelle 3. BasicAuthentication
Ihren Namen	Datentyp	Erforderlich
Benutzername	Zeichenfolge	Ja
Kennwort	Zeichenfolge	Nein

XML-Beispiel

In diesem Beispiel werden ein Authentifizierungsbenutzername und ein Kennwort festgelegt.

<BasicAuthentication username="${/username}" password="${/password}" />

Die folgende Tabelle enthält die Parameter für BearerAuthentication.

Tabelle 4. BearerAuthentication Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Token	Zeichenfolge	Ja	Das Zugriffstoken.

XML-Beispiel

In diesem Beispiel wird ein Zugriffstoken für die Authentifizierung festgelegt.

<BearerAuthentication token="${/access_token}" />

Die folgende Tabelle enthält die Parameter für DigestAuthentication.

Tabelle 5. DigestAuthentication -Struktur
Ihren Namen	Datentyp	Erforderlich
Benutzername	Zeichenfolge	Ja
Kennwort	Zeichenfolge	Ja
Realm	Zeichenfolge	Nein
Nonce	Zeichenfolge	Nein
Algorithmus	Zeichenfolge	Nein
qop	Zeichenfolge	Nein
Cnonce	Zeichenfolge	Nein
nonceCount	Zeichenfolge	Nein

XML-Beispiel

In diesem Beispiel werden ein Benutzername und ein Kennwort für die Authentifizierung festgelegt.

<DigestAuthentication username="${/public_key}" password="${/private_key}" />

Neu in V2

In der folgenden Tabelle sind die Parameter für die Akamai- EdgeGrid -Authentifizierung aufgeführt.

Tabelle 6: Akamai EdgeGrid -Authentifizierungsstruktur
Ihren Namen	Datentyp	Erforderlich
accessToken	Zeichenfolge	Ja
clientToken	Zeichenfolge	Ja
clientSecret	Zeichenfolge	Ja

Neu in V2

Die folgende Tabelle enthält die Parameter für die Hawk-Authentifizierung.

Tabelle 7: Hawk-Authentifizierungsstruktur
Ihren Namen	Datentyp	Erforderlich
keyID	Zeichenfolge	Ja
Schlüssel	Zeichenfolge	Ja
Algorithmus	Zeichenfolge	Ja
Hashwert	Zeichenfolge	Nein
ext	Zeichenfolge	Nein
App-	Zeichenfolge	Nein
Dlg	Zeichenfolge	Nein

Die folgende Tabelle enthält die Parameter für QueryParameter.

Tabelle 8. QueryParameter -Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Name	Zeichenfolge	Ja
Wert	Zeichenfolge	Ja
omitIfEmpty	boolesch	Nein	Übergeht den Parameter, wenn der Wert leer ist.

XML-Beispiel

Dieses Beispiel legt einen Namen und einen Wert für eine Abfrage fest und übergeht den Parameter, wenn der Wert leer ist.

<QueryParameter name="stream_position" value="${/bookmark}" omitIfEmpty="true" />

In der folgenden Tabelle sind die Parameter für RequestHeaderaufgeführt.

Tabelle 9. RequestHeader -Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Name	Zeichenfolge	Ja
Wert	Zeichenfolge	Nein
omitIfEmpty	boolesch	Nein	Lässt den Header aus, wenn der Wert leer ist.

XML-Beispiel

In diesem Beispiel werden Name und Wert für einen Anforderungsheader festgelegt.

<RequestHeader name="authorization" value="client_id:${/client_id}, client_secret:${/client_secret}" />

Neu in V2_1

Die folgende Tabelle zeigt die Parameter für Request Cookie.

Tabelle 10. RequestCookie Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Name	Zeichenfolge	Ja
Wert	Zeichenfolge	Ja
Domäne	Zeichenfolge	Nein	Legt die Domäne für das Cookie fest. Der Standardwert für die Domäne ist der Hostname, der von der`callendpoint url`Attribut. Der Standardwert ist die Domäne des`url`Attribut. Wenn die vom Cookie zurückgegebene Domain nicht mit der Domain URL übereinstimmt, müssen Sie die Domain angeben.
Pfad	Zeichenfolge	Nein	Legt den Pfad für das Cookie fest. Der Standardwert ist der Pfad der Datei`url`Attribut. Wenn der vom Cookie zurückgegebene Pfad nicht mit dem Pfad URL übereinstimmt, müssen Sie den Pfad angeben.
Geheimnis	boolesch	Nein	Verschlüsselt das Wertfeld. Der Standardwert ist auf false gesetzt.

XML-Beispiel

In diesem Beispiel wird das erforderliche Feld (Name und Wert) für ein Anfrage-Cookie festgelegt.

<RequestCookie name=” ${/<savePath>/cookies/<cookie_name>/name}” value=”${/< savePath>/cookies/ <cookie_name> /value}”>

Dieses Beispiel setzt alle erforderlichen und optionalen Felder des Cookies.

<RequestCookie name=” ${/<savePath>/cookies/<cookie_name>/name}” value=”${/< savePath>/cookies/ <cookie_name> /value}” domain=”${/<savePath>/cookies/<cookie_name>/domain}”> path = ”  ${/<savePath>/cookies/<cookie_name>/path}” secret = “true”>

In der folgenden Tabelle sind die Parameter für RequestBodyaufgeführt.

Tabelle 11. RequestBody -Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Typ	Zeichenfolge	Ja	Es muss sich um einen gültigen HTTP Anforderungsinhaltstyp handeln. Beispiel: application/json
Codierung	Zeichenfolge	Ja	Es muss sich um einen gültigen HTTP -Typ handeln. Zum Beispiel UTF-8.
Inhalte	Zeichenfolge	Ja	Fügen Sie den Body-Inhalt zwischen den öffnenden und schließenden Tags des Elements <RequestBody> ein.

XML-Beispiel

In diesem Beispiel werden Inhaltstyp, Hauptteilcodierung und Inhalt für einen Anforderungshauptteil festgelegt.

<RequestBody type="application/json" encoding="UTF-8">{ "grant_type": "client_credentials" }</RequestBody>

Die folgende Tabelle zeigt die Parameter für UrlEncodedFormRequestBody.

Tabelle 12. UrlEncodedFormRequestBody Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Parameter	Map < Zeichenfolge, Zeichenfolge >	Ja	Eine Sammlung von Name/Wert-Paaren.

XML-Beispiel

Dieses Beispiel legt die Name/Wert-Paare für einen URL Formularanfragetext fest.

<UrlEncodedFormRequestBody>
                <Parameter name="grant_type" value="urn:ietf:params:oauth:grant-type:jwt-bearer" />
                <Parameter name="client_id" value="${/client_id}" />
                <Parameter name="client_secret" value="${/client_secret}" />
                <Parameter name="assertion" value="${/jwt_assertion}" />
            </UrlEncodedFormRequestBody>

Die folgende Tabelle zeigt die Parameter für XmlRequestBody.

Tabelle 13. XmlRequestBody Struktur
Ihren Namen	Datentyp	Erforderlich	Hinweise
Typ	Zeichenfolge	Nein	Es muss sich um einen gültigen HTTP Anforderungsinhaltstyp handeln. Beispiel: application/json
Codierung	Zeichenfolge	Nein	Es muss sich um einen gültigen HTTP -Typ handeln. Zum Beispiel UTF-8.
Inhalte	XML	Ja	Der eigentliche XML-Inhalt des Body muss innerhalb des <XmlRequestBody>-Elements als Unterelemente verschachtelt werden.

XML-Beispiel

In diesem Beispiel wird der Inhalt für einen XML-Anforderungshauptteil festgelegt.

<XmlRequestBody>
                <authRequest>
                    <maaS360AdminAuth>
                        <billingID>${/billing_id}</billingID>
                        <platformID>${/platform_id}</platformID>
                        <appID>${/app_id}</appID>
                        <appVersion>${/app_version}</appVersion>
                        <appAccessKey>${/app_access_key}</appAccessKey>
                        <userName>${/username}</userName>
                        <password>${/password}</password>
                    </maaS360AdminAuth>
                </authRequest>
            </XmlRequestBody>

XML-Beispiel:

Diese Aktion ruft eine POST-Anforderung an https://${/host}/auth/oauth2/token mit einem Anforderungsheader und einem Anforderungshauptteil auf und speichert die Antwort im Status /get_access_token.

<CallEndpoint url="https://${/host}/auth/oauth2/token" method="POST" savePath="/get_access_token">
    <RequestHeader name="authorization" value="client_id:${/client_id}, client_secret:${/client_secret}" />
    <RequestBody type="application/json" encoding="UTF-8">{ "grant_type": "client_credentials" }</RequestBody>
</CallEndpoint>