API - Authentifizierung

Eine Authentifizierung ist bei jeder API-Anfrage notwendig, um die Sicherheit und Integrität der Daten zu gewährleisten. Die Authentifizierung erfolgt über die Makler-ID und seinem zugehörigem Token.

  • Die Makler-ID erhalten Sie bei der Registrierung Ihres Maklerkontos.
  • Das Token erstellen Sie, indem Sie Ihren Benutzer auf unserer Platform bearbeiten, auf den Reiter "Schnittstellen" klicken und den Button "Login Token anlegen" anklicken. Dort finden Sie auch jederzeit Ihr bereits erstelltes Token.
  • Sie können das Token jederzeit erneuern, um die Sicherheit zu erhöhen. Das Token ist nur für den Benutzer gültig, der es erstellt hat.
  • Das Token ist nur für eine begrenzte Zeit gültig. Das Ablaufdatum des Tokens können Sie ebenfalls im Reiter "Schnittstellen" einsehen oder bei erfolgreicher Authentifizierung der API-Anfrage.
  • Bei Änderung des Benutzer-Passworts verfällt auch das Login-Token.

Technische Anforderungen an die API-Kommunikation

Domain Live: login.policenwerk.de
Domain für Testzwecke: test.policenwerk.de

  • Alle Anfragen werden als HTTP-POST übertragen.
  • Das Datenformat für Anfragen und Antworten ist stets application/json.
  • Die API ist ausschließlich über HTTPS erreichbar.
  • Die SSL/TLS-Verschlüsselung der Server kann über SSL Labs unabhängig überprüft werden: SSL Labs (Analyse login.policenwerk.de).
  • Die genaue Endpunkt-URL entnehmen Sie der jeweiligen API-Dokumentation.

Login-Daten

Feldname Datentyp Beschreibung Notwendigkeit
login_token UUID (v5)
char(36)
Authentifizierungs-Token
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Pflichtfeld
user_id integer
mediumint(8) unsigned
Makler-ID des Tokens
Pflichtfeld

Antwort bei Fehlern

HTTP-Statuscodes

  • 400 Bad Request: Die Anfrage ist fehlerhaft oder unvollständig.
  • 401 Unauthorized: Authentifizierung fehlgeschlagen, z.B. ungültiges Token oder Benutzer-ID.

Fehlerliste

HTTP-Statuscode JSON-Feld "error" enthält Beschreibung
400 Bad Request Invalid Content-Type - Expected application/json
400 Bad Request Invalid Content-Type - Malformed JSON
401 Unauthorized Invalid credentials - User-ID or Login-Token is not set
401 Unauthorized Invalid credentials - User-ID invalid
401 Unauthorized Invalid credentials - Login-Token invalid
401 Unauthorized Invalid credentials - Login-Token expired
401 Unauthorized Invalid credentials - Login-Token do not match
401 Unauthorized Invalid credentials - ..weitere mögliche seltenere Fehler (z.B: Makler oder Firma deaktiviert, ..)

Antwort bei Erfolg

HTTP-Statuscodes

  • Der zurückgegebene HTTP-Statuscode entspricht immer dem Status der gesamten Anfrage.
  • Authentifizierung erfolgreich, aber fehlerhafte oder unvollständige Nutzdaten: Die API gibt einen 400-Bad Request zurück, auch wenn das Login korrekt war.

JSON-Felder

Feldname Datentyp Beschreibung Wann erhältlich
login boolean
true/false
Gibt an, ob die Authentifizierung erfolgreich war. Immer
token_valid_until string
YYYY-MM-DD HH:MM:SS
Gültigkeitsdatum, bis zu dem Sie das Token verwenden können. Nur bei erfolgreicher Authentifizierung
warning string
varchar(x)
Login-Token is about to expire in less than 14 days Nur bei fast abgelaufenem Token

Beispiele

curl -X POST "https://test.policenwerk.de/api/brille/sendContract" -H "Content-Type: application/json" -d \ '{ "user_id": "", "login_token": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }' Antwort Beispiele: {"login":false,"error":"Invalid credentials - Login-Token invalid"} {"login":false,"error":"Invalid credentials - User-ID does not match Login-Token"} {"login":true,"token_valid_until":"2027-06-11 00:00:00","warning":"","error":""} {"login":true,"token_valid_until":"2025-06-11 00:00:00","warning":"Login-Token is about to expire in less than 14 days","error":""}