Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Öffnen von Talend Cloud API Tester über eine beliebige Website

Mit Talend Cloud API Tester können Sie in Ihrer Website eine Schaltfläche einfügen, über die Sie direkt einen Request in Talend Cloud API Tester öffnen können.

Prozedur

  1. Fügen Sie auf Ihrer HTML-Seite den folgenden meta-Tag hinzu, um die Seite mit Talend Cloud API Tester zu verknüpfen.
    <meta   name="dhc-aware-page"   data-indicator-element-id="<id_element>"   data-console-debug="<allow-debug-logs>" >
    Parameterinformationen
    Parameter Typ Erforderlich Beschreibung
    name String (Zeichenfolge) Ja Der Wert muss dhc-aware-page sein.
    data-indicator-element-id String (Zeichenfolge) Nein Gibt die ID des Elements an, das Talend Cloud API Tester in der Seite einfügen soll, um es dort zur Verfügung zu stellen. Standardwert: dhcInfo.
    data-console-debug Boolean (Boolescher Wert) Nein Wenn der Wert true ist, werden Debug-Informationen in die JavaScript-Konsole des Browsers geschrieben (auf Ihrer Seite). Standardwert: false.

    Das eingefügte Element sieht folgendermaßen aus:

    <script id="my-id" client-indicator="my-id" type="dhc/info">
       {"dhcVersion":"23.0.1","extensionId":"aejoelaoggembcahagimdiliamlcdmfm"}
    </script>
  2. Rufen Sie window.postMessage mit dem folgenden Nachrichtenobjekt auf, um das Öffnen von Talend Cloud API Tester auszulösen.
    {
          target : "<extension_id>",
          type : "<type>",
          payloadType: "<type_of_payload>",
          payload : "<payload>",
          shouldReplaceOriginTab: <shouldReplaceOriginTab>
    }             
    Parameterinformationen
    Parameter Typ Erforderlich Beschreibung
    target String (Zeichenfolge) Ja

    Die ID der Erweiterung von Talend Cloud API Tester. Die ID kann über das Indikatorelement von Talend Cloud API Tester abgerufen werden. Beispiel: JSON.parse(document.querySelector('script[type="dhc/info"]').innerText).extensionId

    Oder Sie setzen data-indicator-element-id im meta-Tag auf my-id: JSON.parse(document.getElementById('my-id').innerText).extensionId

    type String (Zeichenfolge) Ja

    Der Typ der Nachricht. Verweist Talend Cloud API Tester auf die Aktion, die durchgeführt werden soll. Mögliche Werte: openRequest und openExtension (Öffnen ohne Laden eines Requests).

    payloadType String (Zeichenfolge) Ja Der typ der in Talend Cloud API Tester zu ladenden Payload. Mögliche Werte: apiTester, wenn der Parameter type auf openRequest gesetzt ist, oder none, wenn auf openExtension gesetzt.
    payload String (Zeichenfolge) Nur, wenn type gleich openRequest. Der zu ladende Request, wenn type auf openRequest gesetzt ist. Siehe nachstehendes Beispiel.
    shouldReplaceOriginTab Boolean (Boolescher Wert) Nein Gibt an, ob Talend Cloud API Tester über das Senden von window.postMessage auf der Registerkarte oder auf einer neuen Registerkarte geladen werden soll. Standardwert: false.

    Example

    {
       "name": "Post example on HTTP Bin",
       "headers": [
           {
               "enabled": true,
               "name": "Content-Type",
               "value": "application/json"
           }
       ],
       "type": "Request",
       "method": {
           "requestBody": true,
           "link": "",
           "name": "POST"
       },
       "body": {
           "autoSetLength": true,
           "textBody": "{\n  \"lastname\": \"Eastwood\",\n  \"firstname\": \"Clint\"\n}",
           "bodyType": "Text"
       },
       "headersType": "Form",
       "uri": {
           "path": "httpbin.org/post",
           "query": {
               "delimiter": "&",
               "items": [
                   {
                       "enabled": true,
                       "name": "details",
                       "value": "full"
                   }
               ]
           },
           "scheme": {
               "secure": true,
               "name": "https",
               "version": "V11"
           }
       }
    }

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!