Zu Content springen
Deutsch
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

Benutzerdefinierte API-Anfrage

API steht für „Application Programming Interface“ (Programmierschnittstelle). Die Schnittstelle kann als Dienstleistungsvertrag zwischen zwei Anwendungen betrachtet werden.

Um ein benutzerdefiniertes API-Anforderungselement hinzuzufügen, klicken Sie einfach mit der rechten Maustaste auf eine freie Stelle in Ihrem Rahmen.

 
Klicken Sie auf das Element, um die Seitenleiste zu öffnen. In der Seitenleiste können Sie die Anforderungs-URL eingeben, den Inhaltstyp angeben und auch eine Transformationsregel für Ihre Variablen hinzufügen. Sie können die Anforderung auch mit der Schaltfläche unten in der Seitenleiste testen.
 
 

Ändern Sie den Anfragetyp:

 

Ändern Sie die Überschrift bei Bedarf:

 

Überschriftstypen:

  •  Autorisierung: Enthält die Authentifizierungsdaten für die HTTP-Authentifizierung. 
  •  WWW-Authenticate: Der Server kann dies als erste Antwort senden, wenn er eine Form der Authentifizierung benötigt, bevor er mit der eigentlichen angeforderten Ressource antwortet. Oft folgt auf diesen Header der Antwortcode 401, was „nicht autorisiert“ bedeutet. 
  •  Accept-Charset: Dieser Header wird mit der Anfrage gesetzt und teilt dem Server mit, welche Zeichensätze (z. B. UTF-8, ISO-8859-1, Windows-1251 usw.) vom Client akzeptiert werden. 
  •  Content-Type: Gibt dem Client an, in welchem Medientyp (z. B. application/json, application/javascript usw.) eine Antwort gesendet wird. Dies ist ein wichtiges Header-Feld, das dem Client hilft, den Antworttext korrekt zu verarbeiten.
  •  Cache-Control: Die vom Server für diese Antwort definierte Cache-Richtlinie. Eine zwischengespeicherte Antwort kann vom Client gespeichert und bis zu dem im Cache-Control-Header definierten Zeitpunkt wiederverwendet werden.
      

Anfragetypen::

Wir unterstützen GET, POST, PUT, PATCH, DELETE
 
 

Körperbau: 

POST, PUT, PATCH Körperbau: sind:
  •  Raw: JSON, Text, HTML 
  •  Form data 
  •  URL Encoded
     
    •  
       
     
     

    Speichern Sie die Informationen aus Ihrer API in einer Variablen:

     
     
    To pick up a draggable item, press the space bar. While dragging, use the arrow keys to move the item. Press space again to drop the item in its new position, or press escape to cancel.
     
    $
    Das Stammobjekt oder Array.
    .property
    Wählt die angegebene Eigenschaft in einem übergeordneten Objekt aus.
     

    In Variablen gespeicherte Informationen können in anderen API-Aufrufen verwendet und vom Roboter gesprochen werden:

     
     
    Verwenden Sie dies #ATTRI/name_of_the_variable
     
    wo auch immer Sie den Wert der Variablen einfügen müssen. (Zum Beispiel, damit der Roboter laut ausspricht, was in der Variablen gespeichert ist, oder als Information für einen anderen API-Aufruf.)
     
     

    Wenn eine API keine „Cross-Origin“-Anfragen (cors) unterstützt, ändern Sie den Parameter von „application/json“ in „text/plain“! 

    API-Anfragen müssen über HTTPS erfolgen. HTTP wird nicht unterstützt.
     

    Anforderungsprofil oder Spezifikation für API-Schnittstellen

    •  Anfrageformat
       
      Unsere API unterstützt die Kommunikation über die Methoden POST, PUT und PATCH. Kunden sollten die geeignete Methode je nach Art ihrer Anfrage auswählen. Die POST-Methode wird in der Regel für die Erstellung neuer Daten verwendet, PUT für die Aktualisierung vorhandener Daten und PATCH für Teilaktualisierungen.
       
    •  Körpertypen
       
      Für den Hauptteil der API-Anfragen akzeptiert unsere Schnittstelle die folgenden Typen:
       
      Roh: Dies umfasst Formate wie JSON, Text und HTML. Das Rohformat eignet sich für den Versand unstrukturierter Daten oder komplexer verschachtelter JSON-Objekte.
       
      Formulardaten: Dieser Typ eignet sich ideal für das Senden strukturierter Daten, die aus Schlüssel-Wert-Paaren bestehen.
       
      URL-codiert: Verwenden Sie dieses Format für einfache Textdaten, die als Teil der URL codiert sind und häufig in Abfrageparametern verwendet werden.
       
    •  Umgang mit CORS
       
      Wenn Ihre Anwendung CORS (Cross-Origin Resource Sharing) nicht unterstützt, empfehlen wir, den Parameter „content-type“ in Ihren Anfragen von „application/json“ in „text/plain“ zu ändern. Durch diese Änderung können Einschränkungen zwischen den Quellen umgangen werden, während die Funktionalität von API-Anfragen gewährleistet bleibt.
       
    •  HTTPS-Anforderung
       
      Um ein Höchstmaß an Sicherheit und Datenintegrität zu gewährleisten, unterstützt unsere API ausschließlich Anfragen, die über HTTPS gestellt werden. HTTP-Anfragen werden nicht akzeptiert. Durch diese Maßnahme werden Ihre Daten und unsere Dienste vor potenziellen Sicherheitsbedrohungen geschützt.
       
    •  Authentifizierung
       
      Wir unterstützen API-Schlüssel und Token- oder Inhaberauthentifizierungsmethoden zur Sicherung von API-Anfragen. Bitte beachten Sie, dass OAuth und SSL-Zertifikatauthentifizierung in unserem System nicht unterstützt werden. Kunden sollten ihren API-Schlüssel oder Inhaber-Token zur Authentifizierung in den Anfrageprotokollkopf einfügen.