Wie funktioniert die Authentifizierung mit Ihrem API-Schlüssel?

Für jeden Aufruf über HTTPS benötigen Sie einen API-Schlüssel. Der Schlüssel legt fest, in welchem Konto Sie arbeiten: Es gibt keinen separaten Benutzernamen und kein Token, das abläuft.

Ihren Schlüssel mitsenden

Die Authentifizierung erfolgt über Basic Auth. Sie tragen Ihren Schlüssel als Benutzernamen ein und lassen das Passwort leer. In curl setzen Sie einen Doppelpunkt hinter den Schlüssel, da curl sonst trotzdem nach einem Passwort fragt.

Wie das mit der Schaltfläche „Try it“ in dieser Dokumentation funktioniert, erfahren Sie unter API mit Try it ausprobieren.

curl https://api.laposta.nl/v2/list \
  -u IHR_API_SCHLUESSEL:

Wenn Sie keinen gültigen Schlüssel mitsenden, gibt die API eine 401-Fehlermeldung zurück:

{
  "error": {
    "type": "invalid_request",
    "message": "No valid API-key provided"
  }
}

Einen Schlüssel erstellen

Sie können Schlüssel in Ihrem Konto unter „Verbindungen“ erstellen. Wie Sie dabei genau vorgehen, was Sie danach noch von einem Schlüssel sehen können und wie viele Schlüssel Sie erstellen können, lesen Sie unter API-Schlüssel erstellen.

Sicherer Umgang mit Ihrem Schlüssel

Ein Schlüssel gewährt Zugriff auf alle Daten des Kontos, behandeln Sie ihn daher wie ein Passwort.

Arbeiten Sie stattdessen mit einer Umgebungsvariable oder dem Secrets-Speicher Ihres Hosting-Anbieters und lassen Sie die Aufrufe über Ihren eigenen Server laufen. Wenn Sie etwas testen möchten, verwenden Sie dafür eine separate Liste in Ihrem eigenen Konto. Tun Sie das vor allem bei Endpoints, mit denen Sie Daten anlegen oder löschen. Ein separates kostenloses Testkonto lässt sich in den meisten Fällen nicht erstellen: Siehe Ein kostenloses Konto pro Organisation.

Verwandte Artikel