Eine API aus einer Automatisierung aufrufen

Verwende einen HTTP-Schritt, wenn eine Automatisierung eine externe API braucht, für die es keinen eigenen Connector gibt. http.get liest, http.send schreibt mit POST, PUT, PATCH oder DELETE. Ein Senden ändert Daten außerhalb von Tale, deshalb fragt ein Live-Lauf zuerst nach einer Freigabe, wie bei jedem Schreiben. Ein Testlauf sendet nie: Er antwortet mit einem Mock.

Aus einer API lesen

nodes:
  - id: orders
    type: http.get
    credential: Shop API
    input:
      url: /orders
      query: { status: open }

Der Schritt gibt { status, ok, headers, body } zurück. body enthält das geparste JSON oder den Text, bei einer leeren Antwort null. headers behält content-type, etag, last-modified, location, link, retry-after und die x-ratelimit--Header und verwirft die übrigen. Ein Status außerhalb von 200–299 lässt den Schritt scheitern, es sei denn, okStatuses nennt ihn; dann ist ok gleich false, und ein späterer Schritt entscheidet, was mit der Antwort geschieht.

An eine API senden

http.send nimmt dieselben Eingaben und drei weitere: method (POST, PUT, PATCH oder DELETE, erforderlich), body und contentType. Ein JSON-Wert in body wird als JSON gesendet. Ein String wird so gesendet, wie er ist, mit contentType oder ohne Angabe als text/plain.

nodes:
  - id: create_order
    type: http.send
    credential: Shop API
    input:
      url: /orders
      method: POST
      body:
        item: '{{ input.item }}'
        quantity: 2

Mit Zugangsdaten anmelden

Füge unter Einstellungen › Connectors Zugangsdaten zu HTTP hinzu. Wähle, wie sie sich anmelden: mit einem Bearer-Token, einem API-Key in einem Header oder mit Benutzername und Passwort. Gib ihre Basis-URL ein, etwa https://api.example.com/v2; bei einem API-Key nennt API-Key-Header den Header, standardmäßig X-Api-Key. Gib den Zugangsdaten einen Namen und nenne ihn im Feld credential des Schritts.

Ein Schritt mit Zugangsdaten bleibt unter der Basis-URL. Ein Pfad wird darunter gesetzt, eine vollständige Adresse muss mit ihr beginnen, und eine Weiterleitung darf sie nicht verlassen. Nur die Zugangsdaten melden die Anfrage an. Wo eine Antwort einen ihrer Werte zurückgeben würde, ersetzt Tale ihn durch [redacted], sodass er nie in die Aufzeichnung eines Laufs gelangt.

Ein Schritt ohne Zugangsdaten trägt keine, nie die Standard-Zugangsdaten der Organisation, und ruft nur öffentliche https://-Adressen auf.

Was Tale ablehnt

• Eine Adresse in einem privaten Netzwerk oder eine Metadatenadresse einer Cloud, mit oder ohne Zugangsdaten.
• Eine einfache http://-Adresse. Der Editor warnt vor dem Speichern davor.
• Einen Benutzernamen oder ein Passwort in der Adresse oder Zugangsdaten in einem ihrer Query-Parameter: Der Editor lehnt das Speichern ab. Speichere die Zugangsdaten stattdessen unter Einstellungen › Connectors.
• Einen Authorization- oder Cookie-Header, den der Schritt setzt. Auch das lehnt der Editor ab.
• Eine Antwort über 1 MB.

Die HTTP-Schritte einer Organisation machen höchstens 120 Aufrufe pro Minute im ganzen Deployment und 10 gleichzeitig auf einem Server. Ein Aufruf über dem Budget der Minute scheitert; einer über der Zahl gleichzeitiger Aufrufe wartet auf einen freien Platz, solange sein timeoutMs es zulässt.

Wenn ein Schritt scheitert

Die Seite des Laufs sagt, warum ein HTTP-Schritt gescheitert ist und wie du es behebst. Die Ausführungsprotokolle erklären, wie du den Fehler liest.