Authentifizierung
Jede Anfrage an die API enthält einen API-Schlüssel. Anfragen werden nie einer Browsersitzung zugeordnet.
API-Schlüssel erstellen
Erstellen Sie in Ihrem Konto unter API-Schlüssel bis zu 5 Schlüssel. Solange Sie angemeldet sind, können Sie einen Schlüssel auf dieser Seite jederzeit kopieren: Wir speichern ihn verschlüsselt und zeigen ihn nur Ihnen an. Halten Sie ihn wie ein Passwort geheim, und wenn er gesehen worden sein könnte, widerrufen Sie ihn und erstellen Sie einen neuen.
API-Schlüssel senden
Senden Sie ihn im Header Authorization als Bearer, gefolgt vom Schlüssel. X-API-Key funktioniert ebenfalls.
curl "https://api.talismanleads.io/v1/account" \
-H "Authorization: Bearer tl_live_your_key_here"Was ein API-Schlüssel kann
Ein neuer API-Schlüssel kann alles: Ihr Guthaben, die Prüfungen, Ihre Aufträge und deren Ergebnisse sehen sowie POST /uploads, POST /estimates und POST /orders verwenden, die Ihre Liste speichern oder Ihr Guthaben ausgeben. Ein Schlüssel, der vor dem 8. November 2026 erstellt wurde, hat möglicherweise nur Lesezugriff: Er kann alles sehen, aber diese drei Aufrufe lehnen ihn mit missing_scope ab.
Ablauf und IP-Adressen
Ein neuer API-Schlüssel läuft nie ab und funktioniert von jeder Adresse aus. Ein Schlüssel, der vor dem 8. November 2026 erstellt wurde, kann ein Ablaufdatum haben, nach dem er mit expired_key abgelehnt wird, oder auf die IP-Adressen Ihres Servers beschränkt sein, sodass eine Anfrage von einer anderen Adresse mit ip_not_allowed abgelehnt wird. Um eines davon zu ändern, erstellen Sie einen neuen Schlüssel und widerrufen Sie den alten.
API-Schlüssel schützen
- Behandeln Sie einen API-Schlüssel wie ein Passwort: Wer ihn besitzt, kann Ihr Guthaben ausgeben.
- Verwenden Sie ihn nur auf Ihrem Server. Die API erlaubt keine Aufrufe von einer Webseite aus.
- Halten Sie ihn aus Ihrem Code und Ihrer Versionsverwaltung heraus.
- Wenn ein Schlüssel gesehen worden sein könnte, widerrufen Sie ihn sofort in Ihrem Konto. Er funktioniert dann umgehend nicht mehr. Bereits erteilte Aufträge laufen weiter.
- Senden Sie ihn nur an die API. Upload- und Download-Links haben ihre eigene Berechtigung, senden Sie Ihren API-Schlüssel also nicht an diese Links.
Wenn ein API-Schlüssel abgelehnt wird
Ein falscher, widerrufener oder abgelaufener Schlüssel ergibt die Antwort 401. Ein gesperrter Schlüssel oder ein gesperrtes Konto ergibt die Antwort 403. Siehe Fehler.