Verbindungen

Wofür dienen Verbindungen?

Schnittstellen verwenden normalerweise eine Authentifizierung/Autorisierung meist mittels API-Keys, um den Zugriff auf ihre Endpunkte einzuschränken. Es wird also eine Art "Health-Check" zur Überprüfung der Erreichbarkeit und Verifizierung des Endpunktes und des API-Keys eingerichtet.

Jedes Modul benötigt für die Aktivierung eine Verbindung, die eine Antwort mit dem HTTP-Status zwischen 200 und 299 zurückgibt, damit eine erfolgreiche Abfrage gewährleistet wird. Mehere Module können auch die gleiche Verbindung verwendet, wenn z.B. der gleiche API-Key verwendet wird.

Um dies zu ermöglichen muss für jede Verbindung ein HTTP-Abfrage mit den entsprechenden Parametern erstellt werden.

Erstellung HTTP-Abfrage

HTTP-Abfrage der Verbindung

Erklärung Bestandteile HTTP-Abfrage

Bei der HTTP-Abfrage wird eine vollständige Anfrage an den gewünschten Endpunkt in JSON-Form erstellt.

• url: Erweiterung der Basis-URL um den gewünschten Endpunkt

• headers:

  • Content-Type: Festlegung auf JSON-Format des Anforderungs-Headers und der Antwort

  • meist wird hier noch für die Autorisierung "authorization" ein Token oder API-Key mit dem Platzhalter {{parameters.apiKey}}

• method: Methode des Aufrufes (GET)

Beispiel - HTTP-Abfrage

{
  "url": "{{baseUrl}}/random",
  "method": "GET",
  "headers": {
    "Content-Type": "application/json"
  }
}

Festlegen der Parameter

Basierend auf diesen Parametern wird die Verbindung eingerichtet. Für die Aktivierung der Verbindung müssen in der App-Ansicht die Parameter ausgefüllt werden. Nach erfolgreichem Ausfüllen wird die HTTP-Abfrage mit diesen Parameter ausgeführt.

Festlegung API-Key bzw. Parameter

Erklärung Bestandteile Parameter

• name: Eindeutiger Namen des Parameters

• type: Datentyp (text, number oder boolean)

• label: Label, das im Bot Builder im entsprechenden App-Modul aufgeführt ist

• required: Gibt an, ob der Parameter erforderlich ist (true oder false)

Beispiel - Parameter

[
  {
    "name": "apiKey",
    "type": "text",
    "label": "API Key",
    "required": true
  }
]

Parameter müssen in einem Array angegeben werden, ansonsten können die Änderungen nicht übernommen werden. ( in eckigen Klammern: [ ] )