Zum Hauptinhalt springen

Authentifizierung

Jede Anfrage an die Lead-API muss einen gültigen, aktiven Lead-Schlüssel enthalten. Es gibt zwei Wege, ihn zu übergeben:

WegVerwendung
Header X-API-KeyREST-Anfragen und JavaScript-SDK
Feld _key im BodyHTML-Formulare, bei denen kein Header gesetzt werden kann

Ist der Header gesetzt, wird das Feld _key ignoriert.

POST /api/public/leads HTTP/1.1
Host: app.advision360.de
Content-Type: application/json
X-API-Key: YOUR_API_KEY

Lead-Schlüssel verwalten​

Lead-Schlüssel werden in Advision360 unter Einstellungen → Lead- & Formular-Schlüssel erstellt, deaktiviert und gelöscht. Jeder Schlüssel gehört zu einer Firma und einem Benutzer: Leads, die mit dem Schlüssel gesendet werden, landen auf dem Lead-Board dieser Firma.

Ein deaktivierter oder gelöschter Schlüssel wird sofort mit 401 Unauthorized abgewiesen.

Darf der Schlüssel im Browser stehen?​

Ja. Ein Lead-Schlüssel (pk_live_…) ist für den Einsatz auf Websites gedacht und erlaubt ausschließlich das Anlegen von Leads. Er gibt keinen Zugriff auf bestehende Daten. Deshalb steht er beim JavaScript-SDK und beim HTML-Formular sichtbar im Quelltext der Seite.

:::warning Missbrauch begrenzen

  • Verwenden Sie pro Website oder Kampagne einen eigenen Schlüssel. So können Sie einen missbrauchten Schlüssel deaktivieren, ohne andere Formulare zu stoppen.
  • Pro Schlüssel sind 100 Anfragen pro Stunde erlaubt, danach antwortet die API mit 429 (siehe Rate Limit).
  • Tragen Sie nur die Domains als Weiterleitungsziele ein, die Sie wirklich verwenden (siehe Weiterleitung).

:::

Für den Lesezugriff auf Kontakte und andere Firmendaten gibt es die Public API v1 mit eigenen, geheimen Schlüsseln (sk_live_…). Diese dürfen nie im Browser verwendet werden.