Parameter und Platzhalter 11. Februar 2020 www.monsum.com
FastBill GmbH Taunustor 1-3 6.Stock 60310 Frankfurt am Main
Monsum
Dokumentation
Parameter und Platzhalter
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
1. Hosted Pages Parameter ...3
1.1 Die Kundendaten ... 3
1.2 Die Abodaten ... 4
1.3 x-Attribute, sec_token und check ... 5
2. Platzhalter ...6
2.1 Automatische E-Mails... 6
2.2 Freitextfeld der Dokumenten-Vorlage ... 7
2.3 E-Mail Text der Dokumenten-Vorlage ... 9
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
1. Hosted Pages Parameter
Zur Vereinfachung der Nutzung der Hosted Pages besteht vor dem Versand des entsprechenden Links die Möglichkeit, kundenspezifische Daten hinzuzufügen. Dabei kann entweder die Hosted Page oder ihr Inhalt angepasst werden.
Die Parameter mit der Abkürzung S füllen die Felder der Hosted Pages.
Wenn durch Einsetzen des Parameter Änderungen erfolgen, die für den Kunden nicht sichtbar sind oder welche die gesamte Hosted Page betreffen, so ist dies mit V abgekürzt.
1.1 Die Kundendaten
Die Parameter werden an die URL mit ¶meter=value angefügt (z.B. &lang=es um die Seite in spanischer Sprache anzuzeigen.
Parameter Erklärung Beispiel
address_line1 Adresse Bullway 13 S
affiliate Affiliate Max Muster V
city Ort Kuhtown S
company Unternehmen Milchmann S
country Land DE, FR, CH S
customer_ext_uid externe Kunden-ID 001513 V
customer_ext_number Kundennummer in Monsum 5000 V
email E-Mail-Adresse j.smith@kalbmail.de S
first-name Vorname John S
language / lang übersetzt die gesamte Seite (und die Kundensprache im Backend wird angepasst)
en, it, fr, es V
last-name Nachname Smith S
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
Parameter Erklärung Beispiel
newsletter Newsletter 1 V
postal-code Postleitzahl 85246 S
salutation Anrede Herr S
tags Tags reseller, berlin S
telephone, phone Telefonnummer 017623456789 S
title_academic Titel Dr. S
vatid Umsatzsteuer-ID DE999999999 S
1.2 Die Abodaten
Die Parameter werden an die URL mit ¶meter=value angefügt (z.B. &productQuantity=7 um die Anzahl der bestellten Produkte auf 7 zu stellen).
Parameter Erklärung Beispiel
product_description Produktbeschreibung trockenes Gras V
productQuantity Produktanzahl 7 V
product_title Produkttitel Heu V
promocode Rabattcode SummerSale S
start Startdatum Format: JJJJ-MM-TT 2015-06-26 V
subscription_ext_uid externe Abonnement-ID 12345 V subscription_title Titel des Abonnements Heu-Abo J. Smith V success_url URL für Erfolg der Abo-Buchung
(doppelt encodiert, also z.B.
%253A%252F%252 anstatt :// .
https%253A%252F
%252Ffastbill.com%
252F erfolg.php
V
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
1.3 x-Attribute, sec_token und check
Die Parameter werden an die URL mit ¶meter=value angefügt (z.B. &lang=es um die Seite in spanischer Sprache anzuzeigen). Die einzige Ausnahme hierbei sind x-Attribute, die mit
&x_key=value an die URL der Hosted Page angefügt werden (also z.B. & x_Twitter=JohnSmith) .
Paramete Erklärung Beispiel
check Um eine Manipulation der Parameter durch Kunden zu verhindern, kann man diese mit md5 und einem von Monsum festgelegten Salt
verschlüsseln. Sollte die Checksumme nicht mit den Parametern
übereinstimmen kann die Buchung nicht durchgeführt werden.
https://
app.monsum.com/p urchase/
6a7cbd49249c07e d0bbe894c2ec8dfe 3/BASIS-
L&start=2014-09- 08&customer_ext_ui d=
238-5656- d33&check=
a07816297c018f0 05ff
88c595997575e sec_token Um die Sicherheit der Dauerlinks zu
erhöhen, kann man über die API Links abfragen welche mit einen auf 10 min beschränkten Token versehen sind. Wenn der Token abgelaufen ist, kann man den Link nicht mehr aufrufen.
https://app.monsum .com/purchase/
58c190f36c33443 19b
ec22c5fe0647496 /1&sec_token=b29 309620
324bd602bc59db dd5debb79 x_key/x_* = 3value X-Attribute, individuell benennbar.
Werden dem entsprechenden Abonnement angehängt.
x-Twitter, x-Farbe, x- Kleidergroesse value = JSmith, M, rot
V
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
Um Ihnen die Möglichkeit zu geben, automatisierte E-Mails und Dokumente wie Rechnungen zu individualisieren bietet Monsum verschiedene Platzhalter an, mit denen sie beim Individualisieren der Dokument-Vorlagen arbeiten können. Platzhalter müssen immer in %Platzhalter% eingeschlossen sein.
Folgende Platzhalter können in automatischen E-Mails, Freitextfelder der Dokumentenvorlagen und E- Mail Texten genutzt werden:
2.1 Automatische E-Mails
Erklärung Platzhalter
Adressat männlich Herr %firstname% %lastname%
Adressat weiblich Frau %firstname% %lastname%
Adressat Familie Familie %lastname%
Ansprechpartner Männlich z.Hd. Herrn %firstname% %lastname%
Ansprechpartner Weiblich z.Hd. Frau %firstname% %lastname%
Anrede Geschlecht unbekannt Sehr geehrte(r) %firstname% %lastname
Firmenname des Kunden %companyname%
Vorname des Kunden %firstname%
Nachname des Kunden %lastname%
E-Mail Adresse des Kunden %email%
CC- Adresse des Kunden %email_cc%
Adresse des Kunden %address%
PLZ des Kunden %zipcode%
Stadt des Kunden %city%
Land des Kunden %country%
Telefonnummer des Kunden %telephone%
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
Kundenguthaben nach der Rechnungserstellung %credit_balance%
Kontoinhaber %account_owner%
BLZ %bank_code%
Name der Bank %bank_name%
IBAN %iban%
BIC %bic%
Mandatsreferenz %mandate_reference%
Gläubigeridentifikationsnummer %creditor_identifier%
Rechnungsnummer %invoice_number%
Kundennummer %customer_number%
Rechnungsnummer %invoice_number%
Rechnungstitel %invoicetitle%
Link zum Kundendashboard %dashboard_link%
Rechnungslink %invoice_link%
Kündigungslink %cancellation_link%
Passwort des Kundendashboards %password%
Kündigungsdatum %cancellation_date%
2.2 Freitextfeld der Dokumenten-Vorlage
Erklärung Platzhalter
Nachname des Kunden %lastname%
Vorname des Kunden %firstname%
Firmenname des Kunden %cust_companyname%
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
Adressat Familie Familie % lastname%
Ansprechpartner Männlich z.Hd. Herrn % firstname% % lastname%
Ansprechpartner Weiblich z.Hd. Frau % firstname% % lastname%
Geschlecht unbekannt Sehr geehrte(r) % firstname% % lastname%
Kundennummer %realcustomerid%
Ihre Telefonnummer %phone%
Kundentelefonnummer %telephone%
Ihre Faxnummer %fax%
Kundenfaxnummer %telefax%
Standardsprache %language%
Affiliate %partner%
Newsletter Optin (0/1) %newsletter_optin%
Freitext %comment%
Guthaben %credit_balance%
Kontoinhaber des Kunden %account_owner%
BLZ des Kunden %bank_code%
Kontonummer des Kunden %account_number%
Name der Bank des Kunden %bank_name%
Ihre IBAN %iban%
Ihre BIC %bic%
Ihre BLZ %blz%
Ihre Kontonummer %kto%
Angabe der Mahnstufe %dunning_level%
Titel %title%
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
Rechnungsnummer %realinvoiceid%
Kundennummer %realcustomerid%
Gutschriftnummer %creditid%
Leistungszeitraum %deliverydate%
Rechnungsdatum %invoicedate%
PLZ des Kunden %zipcode%
Stadt des Kunden %city%
Land des Kunden %system_countrys_name%
Telefonnummer des Kunden %telephone%
Faxnummer des Kunden %telefax%
Kunden E-Mailadresse %email%
Währung %currency%
Gesamtbetrag %total%
2.3 E-Mail Text der Dokumenten-Vorlage
Erklärung Platzhalter
Nachname des Kunden %cust_lastname%
Vorname des Kunden %cust_firstname%
Firmenname des Kunden %cust_companyname%
Adressat männlich Herr %firstname%
Adressat weiblich Frau %cust_firstname% %cust_lastname%
Adressat Familie Familie %cust_lastname%
Ansprechpartner Männlich z.Hd. Herrn %cust_firstname% %cust_lastname%
Ansprechpartner Weiblich z.Hd. Frau %cust_firstname% %cust_lastname%
Parameter und Platzhalter 11. Februar 2020 www.monsum.com
Ihr Firmenname %companyname%
Ihr Vorname %firstname%
Ihr Nachname %lastname%
Ihre E-Mailadresse %email%
Ihre PLZ %zipcode%
Ihre Stadt %city%
Ihr Land % system_countrys_name%
Ihre Faxnummer %telefax%
Rechnungsnummer %realinvoiceid%
Rechnungsdatum %realinvoicedate%
Nachname des Kunden %lastname%
Vorname des Kunden %firstname%
Firmenname des Kunden %cust_companyname%
Anrede und Name %cust_salutaion%
Kundennummer %realcustomerid%
Währung %currency%
Gesamtbetrag %total%
Rechnungstitel %invoicetitle%
Sollten Sie weitere Fragen haben, kontaktieren Sie uns bitte unter:
support@monsum.com