Zum Hauptinhalt springen

REST-API

Die REST-API bietet volle Kontrolle für Server-zu-Server-Anbindungen und eigene Frontends. Senden Sie die Daten als JSON und den Lead-Schlüssel im Header X-API-Key.

Anfrage senden​

const response = await fetch('https://app.advision360.de/api/public/leads', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'YOUR_API_KEY',
  },
  body: JSON.stringify({
    firstName: 'Max',
    lastName: 'Mustermann',
    email: 'max@example.com',
    phone: '+49 30 1234567',
    source: 'website',
    notes: 'Rückruf am Vormittag gewünscht',
    additionalFields: { budget: '5000' },
    _meta: { url: 'https://www.example.com/kontakt' },
  }),
})

Alle Felder beschreibt die API-Referenz.

Antwort verarbeiten​

Bei Erfolg antwortet die API mit 201 Created und einem leeren JSON-Objekt {}. Bei Fehlern enthält die Antwort ein Feld error, bei Validierungsfehlern zusätzlich violations.

if (response.status === 201) {
  showThankYou()
} else if (response.status === 400) {
  const { violations } = await response.json()
  for (const { field, message } of violations) {
    showFieldError(field, message)
  }
} else if (response.status === 429) {
  const retryAfter = response.headers.get('Retry-After')
  console.warn(`Rate limit erreicht, erneut in ${retryAfter} Sekunden`)
} else {
  const { error } = await response.json()
  console.error(error)
}

Die Meldungen in violations sind deutsch oder englisch, abhängig vom Header Accept-Language der Anfrage (de oder en).

:::info CORS

Die API erlaubt Anfragen aus dem Browser von beliebigen Domains. Erlaubt sind die Methode POST und die Header Content-Type und X-API-Key.

:::

Doppelte Leads​

Ob eine Anfrage einen neuen Lead anlegt oder einen bestehenden aktualisiert, entscheidet die Einstellung Duplikat-Erkennung in den Board-Einstellungen des Lead-Boards:

  • Immer neuen Lead erstellen: jede Anfrage legt einen neuen Lead an.
  • Bestehenden Lead suchen und aktualisieren: passt ein bestehender Lead über E-Mail und/oder Telefon, wird er mit den neuen Daten aktualisiert.

Die Antwort ist in beiden Fällen 201 Created.