ApiKey

Übersicht

Viele Dienste vergeben einen API-Schlüssel, den jede Anfrage in einem Header mitschickt. Ein Konnektor vom Typ ApiKey speichert den Schlüssel verschlüsselt, zusammen mit dem Header und dem Präfix, die der Dienst erwartet. Wie Sie einen Konnektor anlegen, steht unter None.

Den Schlüssel erzeugen Sie beim Dienst selbst, meist unter Einstellungen → API oder Profil → API-Schlüssel.

Struktur

Feld	Bedeutung
API key	der Schlüssel (verschlüsselt gespeichert)
Header	Name des Headers, Standard Authorization; z. B. x-api-key
Scheme	Präfix vor dem Schlüssel, wenn der Header Authorization ist, z. B. Bearer oder token
Base URL	Adresse der API, für Testen und als {{connector.<Name>.BaseUrl}}

Testen sendet den Schlüssel so, wie Header und Scheme es festlegen: Authorization: Bearer <Schlüssel>, oder x-api-key: <Schlüssel>.

Die Aktion HTTPRequest bekommt nur den Namen des Konnektors ("Connector": "<Name>") und sendet den Schlüssel genauso, wie Testen es tut; eine Url wie /orders wird an die Basis-URL angehängt. Wer den Header lieber in der Aktion festlegt, holt nur den Schlüssel aus dem Konnektor:

Der Dienst erwartet	In der Aktion
Authorization: Bearer <Schlüssel>	"AuthType": "Bearer", "AuthToken": "{{connector.<Name>.ApiKey}}"
X-API-KEY: <Schlüssel>	"AuthType": "ApiKey", "AuthToken": "{{connector.<Name>.ApiKey}}"
einen anderen Header	"Headers": { "x-api-key": "{{connector.<Name>.ApiKey}}" }

Beispiel

Konnektor OpenAI aus der Vorlage OpenAI: Header Authorization, Scheme Bearer, Basis-URL https://api.openai.com/v1/. Eine Zusammenfassung des gelesenen PDF-Textes anfordern:

{
  "Type": "HttpRequest",
  "Name": "Zusammenfassen",
  "Parameters": {
    "Url": "/chat/completions",
    "Method": "POST",
    "Connector": "OpenAI",
    "TimeoutSeconds": 60,
    "Body": {
      "model": "gpt-4o-mini",
      "messages": [
        { "role": "user", "content": "Fasse diesen Text in drei Sätzen zusammen:\n{{FileContent}}" }
      ]
    }
  }
}

Die Antwort steht in {{Zusammenfassen.Response.Body.choices.0.message.content}}. Ein weiteres Beispiel mit API-Schlüssel ist Odoo Contacts.