Als User von Kreativ.Management bekommst du von uns direkt ein eigenes Kontaktformular, welches du ganz einfach und ohne Kenntnis auf deine Webseite einbinden kannst.
Unter Umständen möchtest du jedoch dein eigenes Formular (oder eines anderen Anbieters) verwenden. Dies ist nun möglich, wobei es technisch etwas Schwieriger wird. Wenn dem so ist, dann lies dir diesen Artikel unbedingt durch, denn der erklärt dir, wie du hier vorgehen musst.
Dies ist nur für KONTAKTFORMULARE und nicht für Verträge oder Fragebögen möglich.
Übersicht
3.1 JSON
Anlage:
1. Kontaktformular mit API + BEAR Authentification INFORMATION
Um die Daten des Kontaktformulars direkt an Kreativ.Management senden zu können, benötigst du ein Kontaktformular, welches auch imstande ist, mit einer API die Daten an uns weiterleiten zu können.
2. Formular bei Kreativ.Management ERSTELLEN
Erstelle dir zuerst ein neues Kontaktformular mit dem Typ "Kontaktformular API Extern".
Anschließend findest du auf der rechten unteren Seite deinen API Key. Das ist der "Bearer auth key" bzw. die "Formular Id" den du bei deinem Kontaktformular angeben musst. Siehe weitere Schritte unten.
Des Weiteren kannst du hier beim Formular einen Auftragstyp definieren. Wird kein Auftragstyp über das externe Formular mitgesendet, dann wird automatisch dieser Auftragstyp gewählt.
Wenn ein Auftragstyp über das externe Formular mitgesendet wird, wird der mitgesendete Auftragstyp verwendet.
3. WEITERLEITUNG der Daten an Kreativ.Management
So, die Grundlagen sind geklärt. Du hast ein Formular bei Kreativ.Management erstellt, hast den API Key und musst nun dein persönliches Formular so einstellen, dass die Daten direkt an Kreativ.Management weitergeleitet werden.
3.1 JSON
Du musst die Daten deines Formulars per JSON an folgende Url leiten.
Diese URL ist dauerhaft online, auch wenn wir ein Update einspielen. Daher verwende unbedingt diese URL.
Das Format muss wie folgt sein:
{
"formId": "00000000-0000-0000-0000-000000000000",
"values": {}
}"formId" ist dabei der API-Token, den du von uns bekommst (siehe weiter oben).
In den Values musst du nun die gesendeten Daten im richtigen Format senden (siehe 4. MAPPING)
Beispiel:
{
"formId": "00000000-0000-0000-0000-000000000000",
"values": {
"firstname":"Andreas",
"email":"schwarzi_@gmx.at4534"
}
}
Je nachdem welchen Formularanbieter du verwendest, musst du unterschiedliche Einstellungen vornehmen. Hierfür können wir keinen Support anbieten.
3.2 X-WWW-FORM-URLENCODED MÖGLICHKEIT
Unterstützt dein Formular nicht die JSON, dann kannst du die Daten auch via x-www-form-urlencoded an Kreativ.Management übermitteln. Hier ist die URL jedoch eine andere:
Hier musst du die Daten via x-www-form-urlencoded an Kreativ.Management übermitteln. Schicke eine Liste von Key-Value Pair an die entsprechende URL und sende den Bearer Token (API-KEY) mit.
Achtung, damit du diese Möglichkeit verwenden kannst, muss im Header (Kopf) der Übermittlung die Authorisation über Bearer Token funktionieren. Da musst du den API-Key, den du von Kreativ.Management bekommst, angeben. Ansonsten kann das Formular nicht verarbeitet werden.
Im Tool Continually Chatbot schaut dies wie folgt aus:
Header Name = Authorization
Value = Bearer [CODE VON KM]
Wichtig hierbei ist das Leerzeichen zwischen Bearer und den Code.
3.2.1 Beispiel anhand von ContactForm7
Viele User verwenden Wordpress und ContactForm7.
Um ContactForm7 verwenden zu können, benötigst du folgendes zusätzliches Plugin.
https://wordpress.org/plugins/cf7-to-api-basic-auth/ Dies musst du installieren, damit die Daten direkt an Kreativ.Management weitergeleitet werden. Da die Version 1.4.10 nicht mehr funktioniert, musst du bitte hier die Version 1.4.11 runterladen und installieren.
Link zur Version 1.4.11
Ist das Plugin installiert, siehst du in Wordpress bei Formularen diesen Reiter
Wähle nun den Reiter API Integration.
Aktiviere "Send to api"
als "Base url" gibst du https://api.kreativ.management/Form/SubmitExternal ein
Bei "Basic auth key" gibst du den API Key von Kreativ.Management ein. Diese findest du in den Einstellungen des Formulars (siehe weiter oben).
bei "Input type" wählst du "Parameters - GET/POST" aus
bei "Methode" wählst du "POST"
nun werden dir alle Felder, die du bei deinem Kontaktformular abfragst, bei "Form fields" aufgelistet. Hier musst du nun definieren, was du hier abfragst bzw wo das bei Kreativ.Management gespeichert werden soll. Weiter unten findest du das Mapping (siehe 4. Mapping) dazu.
Damit weiß der Büroassistent, dass das Feld "your-firstname" der Vorname des Hauptkontakts ist. Hier musst du also pro Feld einen KEY (siehe Mapping unten) angeben.
So soll das ganze dann, mit deinen Daten entsprechend, ausschauen.
Anschließend speicherst du dein Formular und führst einen Test durch. Sollten die Daten nicht bei Kreativ.Management landen, siehst du hier in den Einstellungen "+ DEBUG LOG (View last transmission attempt") einen Log, der dir anzeigt, warum es nicht geht.
GANZ WICHTIG: teste unbedingt selbst dein Formular und prüfe, ob die Anfrage richtig in deinem Kreativ.Management Account landet.
4. MAPPING der Variablen zu Kreativ.Management
Damit der Büroassistent weiß, welches Feld deines Formulars wo in Kreativ.Management gespeichert werden soll, gibt es das Mapping. Dies definiert die Zuordnung der Felder.
Kontaktperson
Key | Erlaubte Werte | Feld in Kreativ.Management |
firstname |
| Vorname des Hauptkontaktes |
lastname |
| Nachname des Hauptkontaktes |
email (muss gesendet werden) |
| E-Mail-Adresse |
email2 |
| E-Mail-Adresse 2 |
email3 |
| E-Mail-Adresse 3 |
telephone |
| Telefonnummer |
telephone2 |
| Telefonnummer 2 |
telephone3 |
| Telefonnummer 3 |
telephone4 |
| Telefonnummer 4 |
telephone5 |
| Telefonnummer 5 |
website |
| Webseite |
website2 |
| Webseite 2 |
website3 |
| Webseite 3 |
companyname |
| Firmennamen |
tracking | ja, erlauben, aktiv, active, activiate, yes, akzeptiert, accepted, 1 | Signalisiert, ob das E-Mail-Tracking vom Kunden akzeptiert wurde. Hierbei muss eines der erlaubten Werte im Text enthalten sein. |
knownby |
| Bekannt von |
common-lastname |
| Gemeinsamer Nachname |
gender | frau, mrs, female, herr, mr, male | Signalisiert das Geschlecht der Person. Hierbei muss eines der erlaubten Werte im Text enthalten sein. |
birthdaydate |
| Geburtstag Hauptkontakt |
weddingdate |
| Hochzeitstag |
weddingdate2 |
| Hochzeitstag 2 |
weddingdate3 |
| Hochzeitstag 3 |
street |
| Straße |
plz |
| PLZ |
city |
| Ort |
country |
| Land |
typeofperson |
| Personenart |
social |
| Sozialer Kanal |
social2 |
| Sozialer Kanal 2 |
social3 |
| Sozialer Kanal 3 |
social4 |
| Sozialer Kanal 4 |
social5 |
| Sozialer Kanal 5 |
other-field |
| Weiteres Feld |
other-field2 |
| Weiteres Feld 2 |
other-field3 |
| Weiteres Feld 3 |
other-field4 |
| Weiteres Feld 4 |
other-field5 |
| Weiteres Feld 5 |
other-field6 |
| Weiteres Feld 6 |
other-field7 |
| Weiteres Feld 7 |
other-field8 |
| Weiteres Feld 8 |
other-field9 |
| Weiteres Feld 9 |
other-field10 |
| Weiteres Feld 10 |
notes |
| Notizen |
language |
| Sprache |
right-of-publication |
| Veröffentlichungsrecht |
title-before |
| Titel |
title-after |
| Titel nach. |
extra-field |
| Extra Feld |
extra-field2 |
| Extra Feld 2 |
extra-field3 |
| Extra Feld 3 |
extra-field4 |
| Extra Feld 4 |
extra-field5 |
| Extra Feld 5 |
Auftrag
API Key | Erlaubte Werte | Beschreibung |
eventtype | muss ein gültiger Name eines deiner Auftragstypen sein | Auftragstyp |
startdate | Gültiges Format dd.MM.yyyy HH:mm | Auftragsdatum Start |
enddate | Gültiges Format dd.MM.yyyy HH:mm | Auftragsdatum End |
message |
| Nachricht |
location |
| Lokation |
Weitere Personen
API Key für Zweitkontakt | API Key für Drittkontakt | Beschreibung |
secondcustomerfirstname | thirdcustomerfirstname | Vorname |
secondcustomerlastname | thirdcustomerlastname | Nachname |
secondcustomeremail | thirdcustomeremail | E-Mail-Adresse |
secondcustomeremail2 | thirdcustomeremail2 | E-Mail-Adresse 2 |
secondcustomeremail3 | thirdcustomeremail3 | E-Mail-Adresse 3 |
secondcustomertelephone | thirdcustomertelephone | Telefonnummer |
secondcustomertelephone2 | thirdcustomertelephone2 | Telefonnummer 2 |
secondcustomertelephone3 | thirdcustomertelephone3 | Telefonnummer 3 |
secondcustomertelephone4 | thirdcustomertelephone4 | Telefonnummer 4 |
secondcustomertelephone5 | thirdcustomertelephone5 | Telefonnummer 5 |
secondcustomerwebsite | thirdcustomerwebsite | Webseite |
secondcustomerwebsite2 | thirdcustomerwebsite2 | Webseite 2 |
secondcustomerwebsite3 | thirdcustomerwebsite3 | Webseite 3 |
secondcustomercompanyname | thirdcustomercompanyname | Firmennamen |
secondcustomergender | thirdcustomergender | Geschlecht |
secondcustomerbirthdaydate | thirdcustomerbirthdaydate | Geburtstag |
secondcustomerstreet | thirdcustomerstreet | Straße |
secondcustomerplz | thirdcustomerplz | PLZ |
secondcustomercity | thirdcustomercity | Ort |
secondcustomercountry | thirdcustomercountry | Land |
secondcustomer typeofperson | thirdcustomer typeofperson | Personenart |
secondcustomersocial | thirdcustomersocial | Sozialer Kanal |
secondcustomersocial2 | thirdcustomersocial2 | Sozialer Kanal 2 |
secondcustomersocial3 | thirdcustomersocial3 | Sozialer Kanal 3 |
secondcustomersocial4 | thirdcustomersocial4 | Sozialer Kanal 4 |
secondcustomersocial5 | thirdcustomersocial5 | Sozialer Kanal 5 |
secondcustomerother-field | thirdcustomerother-field | Weiteres Feld |
secondcustomerother-field2 | thirdcustomerother-field2 | Weiteres Feld 2 |
secondcustomerother-field3 | thirdcustomerother-field3 | Weiteres Feld 3 |
secondcustomerother-field4 | thirdcustomerother-field4 | Weiteres Feld 4 |
secondcustomerother-field5 | thirdcustomerother-field5 | Weiteres Feld 5 |
secondcustomerother-field6 | thirdcustomerother-field6 | Weiteres Feld 6 |
secondcustomerother-field7 | thirdcustomerother-field7 | Weiteres Feld 7 |
secondcustomerother-field8 | thirdcustomerother-field8 | Weiteres Feld 8 |
secondcustomerother-field9 | thirdcustomerother-field9 | Weiteres Feld 9 |
secondcustomerother-field10 | thirdcustomerother-field10 | Weiteres Feld 10 |
secondcustomernotes | thirdcustomernotes | Notizen |
secondcustomer-title-before | thirdcustomer-title-before | Titel |
secondcustomer-title-after | thirdcustomer-title-after | Titel nach. |
ANLAGE
Postman Kreativ.Management API Request