expo-IP CMS Benutzerhandbuch
Für die Nutzung des expo-IP CMS benötigen Sie einen beliebigen aktuellen Browser, der fehlerfrei den aktuellen HTML5 Standard unterstützt. Hierzu zählt NICHT der Browser: Microsoft INTERNET EXPLORER.Messeregistrierung via Webformular
Die folgenden Informationen sind für Web-Admins nutzbar.
Wenn Sie keine Erfahrungen mit dem Erstellen von HTML-Formularen haben, wenden Sie sich bitte an Ihren Web-Administrator.
Für die Besucher-Registrierung kann auf einer Landingpage ein HTML-Formular genutzt werden. An den expo-IP Webhook muss per „POST“ Methode die für die Registrierung erforderlichen Parameter gesendet werden. Die Webhook URL stellt sich wie folgt zusammen:
https://messename.expo-ip.com/api/user/registration/API_KEY(?source=QUELLE – optional)(&conference=KonferenzID – optional)(&send_mail=true/false – optional)
Der MESSENAME ist die Subdomain der Messe, die vor expo-ip.com verzeichnet wurde
Den API_KEY entnehmen Sie bitte im EXPO-IP CMS unter Menü–> Messen –> Reiter „Developer Settings“.
Wenn der optionale Parameter source=QUELLE genutzt wird, wird der Wert hinter source= bei der Registrierung eines Besuchers im Feld „Quelle“ hinterlegt.
Die entsprechenden POST-Parameter:
Pflichtfelder:
- email=[eMail Adresse] Beispiel: test@example.com
- firstname=[Vorname] Beispiel: Test
- lastname=[Nachname] Beispiel: Test
Optional zusätzliche POST-Felder:
- title=[Titel] Beispiel: Prof. Dr.
- salutation=[Anrede] Beispiel: 1 für Herr – 2 für Frau – 3 für divers
Darüber hinaus gibt es noch weitere optionale GET Parameter für den Webhook, welche hinter dem Feld api_key hinzugefügt werden können.
- source: Quelle auf die verwiesen werden soll, von der sich der Benutzer registriert hat
- conference: KonferenzID zu der sich der Besucher registriert
send_mail: Wert false, wenn keine E-Mail von EXPO-IP als Bestätigung verschickt werden soll
Return-Werte
Der expo-IP Webhook wurde erweitert. Es ist nun möglich, von dem Webhook den Freischalt-Hash zu erhalten und das Aussenden der Registrierungsbestätigung zu verhindern. Der Webhook liefert als Return-Wert einen JSON-String.
Messe-Registrierung Webhook:
- authToken: Hash (String)
- alreadyRegistered: false / true
Conference – Registrierung:
- authToken: Hash (String)
- alreadyRegistered: false / true
- resultMessage: Hinweis (String), wenn alreadyRegistered true
Beispielcode für ein Formular und das Anlegen eines Benutzers in PHP:
/* Beispiel für die Messeregistrierung via Webformular */ // API Key hier einsetzen $apiKey = 'xxxxxxxxxxx'; // MESSENAME durch den tatsächlichen Namen der Messe ersetzen $fairname = 'MESSENAME'; $strTargetURL = 'https://' . $fairname . '.expo-ip.com/api/user/registration/' . $apiKey; // zum Hinzufügen weiterer GET Parameter die nachfolgende Zeile auskommentieren // $strTargetURL .= '?source=QUELLE&send_mail=false'; // Die zu sendenden Daten $arrUserdata = array( 'email' => 'info@expo-ip.com', 'firstname' => 'Moritz', 'lastname' => 'Mustermann', 'salutation' => 2, // 1 – Herr / Mr., 2 – Frau / Mrs., 3 – divers / other 'title' => 'Dr.', 'timezone' => 'Europe/Berlin' ); $ch = curl_init($strTargetURL); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, true); // curl_setopt($ch, CURLOPT_HTTPHEADER, array('X-API-KEY: ' . $apiKey)); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $arrUserdata); curl_setopt($ch, CURLOPT_VERBOSE, '1'); curl_setopt($ch, CURLINFO_HEADER_OUT, true); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); if( ! $result = curl_exec($ch)) { die('Ein Fehler ist aufgetreten: ' . curl_error($ch)); } print 'Antwort vom Server:'; print $result;
JSON Ergebnisse
Wenn der Benutzer noch nicht registriert ist und send_mail entweder nicht übergeben oder send_mail=false ist, wird folgender Rückgabewert angezeigt:
{ "authToken":"xxxxxxxx", "alreadyRegistered":false, "resultMessage":"Die Email wurde an die angegebene E-Mail Adresse verschickt" }
Ist der betreffende Benutzer bereits registriert, sieht der Rückgabewert so aus:
{ "authToken":"", "alreadyRegistered":true, "login_hash":null }
Mit dem GET Parameter send_mail=false wird folgender Rückgabewert erzeugt:
{ "authToken":"xxxxxxxx", "alreadyRegistered":false }
Hinweis: Die Lizenz der Messe muss aktiv und gültig sein. Bei einer abgelaufenen Messe funktionieren die oben gezeigten Abfragen nicht.