Skip to main content

API-Schnittstelle (Web-to-CRM)

API-Schnittstelle: Web-to-CRM Integration

Die CloudCRM API ist das digitale Bindeglied zwischen Ihrer Webseite und Ihrer Verwaltung. Sie ermöglicht es, externe Datenquellen (wie Kontaktformulare, Landingpages oder Onlineshops) direkt mit Ihrem CRM zu verknüpfen. Eingehende Anfragen werden in Echtzeit verarbeitet, sicher gespeichert und lösen sofortige Benachrichtigungen an Ihr Team aus.

1. Der API-Endpunkt (Die Adresse)

Alle Daten müssen per HTTP POST an die folgende Adresse gesendet werden:

https://cloudcrm.dwoberland.de/api/v1/lead.php

2. Authentifizierung

Damit das System die Daten Ihrer Firma zuordnen kann, muss bei jeder Anfrage Ihr persönlicher API-Key mitgesendet werden. Sie haben hierzu zwei Möglichkeiten:

  • Option A (Empfohlen): Übermittlung im HTTP-Header als X-API-KEY.

  • Option B (Einfach): Als URL-Parameter am Ende des Links: .../lead.php?key=IHR_API_KEY.

3. Unterstützte Datentypen (type)

Das System erkennt anhand des Feldes "type", wie die Daten verarbeitet werden sollen:

Typ: Web-Bestellung ("type": "order")

Verwenden Sie diesen Typ für Verkäufe oder verbindliche Buchungen auf Ihrer Webseite.

  • Speicherort: Die Daten werden unter "Web Bestellungen" abgelegt.

  • Automatisierung: Das System berechnet die Benachrichtigung basierend auf dem Feld total.

  • Team-Info: Alle Mitarbeiter erhalten sofort eine Push-Benachrichtigung im CRM: "Neue Bestellung! Eine Web-Bestellung über X,XX € ist eingegangen."

Typ: Kontaktanfrage / Support ("type": "ticket")

Verwenden Sie diesen Typ für allgemeine Anfragen oder Support-Formulare.

  • Speicherort: Erstellt automatisch ein neues Ticket in Ihrem Ticketsystem.

  • Intelligente Zuordnung: Erkennt das CRM die E-Mail-Adresse eines bereits existierenden Kunden, wird das Ticket automatisch in dessen digitaler Akte hinterlegt.

  • Fallback: Fehlt ein Betreff, wird das Ticket automatisch unter dem Titel "Anfrage Webseite" angelegt.

4. Technisches Format (JSON)

Die API erwartet die Daten im JSON-Format. Hier ist ein Beispiel für eine vollständige Übertragung:

JSON 

{
  "type": "ticket",
  "email": "max.mustermann@beispiel.de",
  "subject": "Interesse an Beratung",
  "message": "Hallo, ich hätte gerne ein Angebot für Ihre Dienstleistungen.",
  "total": 0.00
}

Datenfelder im Überblick:

Feld Pflicht? Beschreibung
type Ja Entweder "order" oder "ticket".
email Ja E-Mail-Adresse des Absenders (wird zur Kundenzuordnung genutzt).
subject Nein Der Titel des Tickets oder der Bestellung.
message Ja Der eigentliche Textinhalt der Anfrage.
total Nein Nur bei order: Der Bruttobetrag der Bestellung (z.B. 49.90).

5. Rückgabewerte & Fehler

Nach dem Absenden der Daten liefert die API eine Antwort im JSON-Format zurück:

  • Erfolg (200 OK): {"status":"success","message":"Daten verarbeitet","type":"..."}

  • Fehlender Key (401/403): Wenn der API-Key falsch, inaktiv oder nicht mitgesendet wurde.

  • Falsches Format (400): Wenn das JSON ungültig ist oder der type fehlt.

Back to top