Home
METADATEN
Modul: Web Technologien (MMI Master)
Entstehungsjahr: 2018
Autor: Anatol Walger
Keywords: w3c payment request api, tutorial, node.js, kreditkarte
Zielgruppe: Das Tutorial richtet sich an alle, die auf ihrer Webseite Bezahlprozesse abwickeln wollen. Dies sind in erster Linie Unternehmen mit Online-Shops, Crowdfunding-Seiten, Spenden-Seiten.. Überall wo es nötig ist, persönliche Daten + Zahlungsdaten immer wieder neu einzugeben. Natürlich können auch Early Adopter und Technikbegeisterte teilnehmen, die einfach neue Technologien ausprobieren wollen.
Beschreibung: Gegenstand des Tutorials ist die W3C Payment Request API, die am besten in Google Chrome funktioniert und dabei hilft, Zahlungen schneller und eleganter zu tätigen. Ziel soll sein, selber einen Payment Request mit unterstützten Zahlungsmethoden, benötigten Daten des Benutzers und weiteren Parametern (Gesamtsumme, Rabatte) zu erstellen, sodass der Browser einen entsprechenden Payment-Dialog mit den Daten präsentiert, wobei man dann über einen vorher aufgesetzten node.js Server die Zahlung virtuell abwickelt. Ebenso sollen Fälle abgedeckt werden, in denen der Browser keine unterstützte Zahlungsmethode hat oder noch weitere Informationen vom Benutzer notwendig sind (neue bzw. andere Lieferadresse).
Voraussetzungen:
- Grundkenntnisse in Javascript, HTML, CSS
- Erste Erfahrungen mit node.js
- bestenfalls Browser Google Chrome (Version >64)
- Computer/Mac
- Kreditkarte
Herzlich Willkommen zum Tutorial, das Ihnen das W3C Payment Request API näher bringen soll. Mithilfe der nachfolgenden Anweisungen soll es Ihnen so leicht wie möglich gemacht werden, einen node.js Server und die HTML-Webseite für die Ausführung des Payment Requests aufzusetzen.
Nun muss die index.html mit einem beliebigen Editor geöffnet und mit folgendem Code befüllt werden:
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>W3C Payment Request API Tutorial</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
* {
margin: 0;
}
html {
font-family: sans-serif;
line-height: 1.4;
padding: 2em;
}
body> :not(:first-child) {
margin-top: 1.5em;
}
h1,
h2 {
line-height: 1.15;
}
.produkt {
max-width: 13em;
padding: 1em;
background: #fff;
}
.produkt> :not(:first-child) {
margin-top: 0.85em;
}
.produkt_bought {
padding: 1em;
background: #fff;
}
.data_list {
max-width: 100%;
}
.produkt_bought> :not(:first-child) {
margin-top: 0.85em;
}
.produkt_bought {
display: none;
}
.produkt_shadow {
position: relative;
-webkit-box-shadow: 0 1px 4px rgba(0, 0, 0, 0.3);
box-shadow: 0 1px 4px rgba(0, 0, 0, 0.3);
}
.produkt_shadow:after {
content: "";
position: absolute;
z-index: -1;
-webkit-box-shadow: 0 0 40px rgba(0, 0, 0, 0.8);
box-shadow: 0 0 40px rgba(0, 0, 0, 0.8);
bottom: 0px;
left: 10%;
right: 10%;
width: 80%;
height: 50%;
-moz-border-radius: 100%;
border-radius: 100%;
}
.produkt_meta {
display: flex;
align-items: center;
justify-content: space-between;
}
.produkt_button {
background-color: #008CBA;
color: #fff;
padding: 0.25em 1em;
text-decoration: none;
}
</style>
</head>
<body>
<h1>W3C Payment Request API Tutorial</h1>
<p> Teil 1: Einfacher Payment Request </p>
<div class="produkt produkt_shadow" id="produkt">
<h2>Beispielprodukt</h2>
<p>Ich bin ein ganz tolles Produkt! Kauf mich!</p>
<div class="produkt_meta">
<strong class="produkt_preis">nur 49.99 €</strong>
<a href="#" id="produkt_button" class="produkt_button">Kaufen</a>
</div>
</div>
<div class="produkt_bought" id="produkt_bought">
<h2>Beispielprodukt gekauft!</h2>
<p>Sie haben das Beispielprodukt erfolgreich für 49,99 € gekauft.</p>
<p>Ihre Daten:</p>
<div id="data_list"></div>
</div>
<script>
function handleProduktClick(e) {
e.preventDefault();
const creditCardPaymentMethod = {
supportedMethods: 'basic-card',
};
const supportedPaymentMethods = [creditCardPaymentMethod];
const paymentDetails = {
total: {
label: 'Beispielprodukt',
amount: {
currency: 'EUR',
value: 49.99
}
}
};
var paymentRequest = new PaymentRequest(supportedPaymentMethods, paymentDetails);
paymentRequest
.show()
.then(paymentResponse => {
return verifyPaymentWithBackend(paymentResponse).then((success) => {
if (success) {
showPaymentResponse(success);
return paymentResponse.complete('success');
} else {
return paymentResponse.complete('fail');
}
});
})
.catch(err => {
console.log('Error:', err);
});
};
function showPaymentResponse(data) {
document.getElementById("produkt_button").innerHTML = 'Gekauft';
document.getElementById("produkt_button").style.backgroundColor = "#4CAF50";
document.getElementById("produkt_button").removeEventListener('click', handleProduktClick);
document.getElementById("produkt_bought").style.display = "block";
document.getElementById("data_list").innerHTML = data;
}
function verifyPaymentWithBackend(data) {
return new Promise((resolve, reject) => {
var xmlhttp = new XMLHttpRequest();
xmlhttp.onload = function() {
if (xmlhttp.status == 201) {
resolve(xmlhttp.responseText);
} else {
resolve(false)
}
};
xmlhttp.open("POST", "/payment");
xmlhttp.setRequestHeader("Content-Type", "application/json");
xmlhttp.send(JSON.stringify(data));
});
}
document.getElementById("produkt_button").addEventListener('click', handleProduktClick)
</script>
</body>
</html>
Wir gehen die index.html nun Schritt für Schritt durch.
Zunächst werden die üblichen HTML-Tags und Metadaten gesetzt, dann der viewport für die mobile Ansicht. Es folgt das CSS-Styling für die Seite und deren Elemente. Da dies nicht Teil des Tutorials ist, wird nicht weiter darauf eingegangen. Danach folgt der HTML-Code für das Produkt. Das Produkt ist in einem div-Element eingefasst, das eine Überschrift und Produktbeschreibung enthält. Ein weiteres Div ist für den Preis und den "Kaufen"-Button integriert.
Es folgt der Javascript-Code, in dem wir schließlich den PaymentRequest zusammenbauen. Wir beginnen dort mit der Funktion handleProduktClick(e) {}, die durch Klicken auf den Button "Kaufen" gestartet wird. Der entsprechende Event Listener dafür ist weiter unten definiert mit document.getElementById("produkt_button").addEventListener('click', handleProduktClick).
Die Funktion handleProduktClick(e) {} enthält den kompletten Code für den PaymentRequest. Dort wird die Zahlungsmethode per Kreditkarte definiert mit
var creditCardPaymentMethod = {
supportedMethods: 'basic-card',
};
Dies bedeutet, dass wir alle Kreditkarten unterstützten wollen, also auch Prepaid-Kreditkarten, Kreditkarten von Visa, MasterCard etc. Die Variable ist bewusst so genannt, um später weitere Zahlungsmethoden anlegen zu können, die dann in dem Array supportedPaymentMethods hinterlegt werden, was aktuell die obige Zahlungsmethode enthält:
var supportedPaymentMethods = [creditCardPaymentMethod];
Weiter geht es mit den paymentDetails, worin der Gesamtpreis, die Währung, der Einzelpreis und der Name des Produktes eingetragen werden. Diese Informationen sind später auch im PaymentRequest sichtbar.
var paymentDetails = {
total: {
label: 'Beispielprodukt',
amount: {
currency: 'EUR',
value: 49.99
}
}
};
Es folgt schließlich die Definition der Variable paymentRequest, die eines Instanz des PaymentRequests mit obiger Konfiguration definiert.
var paymentRequest = new PaymentRequest(supportedPaymentMethods, paymentDetails);
Danach wird das PaymentRequest-Fenster mit der show()-Methode angezeigt und es wird definiert, was im Erfolgs- bzw. Fehlerfall passieren soll. show() definiert einen Promise, der im Erfolgsfall das Objekt paymentResponse enthält, mit allen Daten, die der Nutzer in das PaymentRequest-Fenster eingegeben hat. Sollte es einen Fehler bei der Rückgabe des paymentResponse geben, wird im PaymentRequest-Fenster der entsprechende Fehler angezeigt return paymentResponse.complete('fail');. Sollte der Benutzer das Fenster schließen oder ein sonstiger Fehler auftreten, wird in den Bereich .catch(err => {}) gesprungen und der Fehler in der Konsole ausgegeben.
paymentRequest
.show()
.then(paymentResponse => {
return verifyPaymentWithBackend(paymentResponse).then((success) => {
if (success) {
showPaymentResponse(success);
return paymentResponse.complete('success');
} else {
return paymentResponse.complete('fail');
}
});
})
.catch(err => {
console.log('Error:', err);
});
};
Die Methode verifyPaymentWithBackend(paymentResponse) ist dazu da, die eingegebenen Daten des Benutzers im PaymentRequest-Fenster an den Server zu schicken. Dies funktioniert durch ein XMLHTTPREQUEST, das die Daten an die vorher definierte Ressource /payment sendet. Sollte, wie bei einem POST üblich, der Statuscode 201 zurückkommen, wurde die Ressource erfolgreich angelegt und die Daten zur Zahlung in der Datenbank gespeichert. Um den Erfolgsfall an den PaymentRequest zurückzugeben, "resolven" wir den Promise und geben als Parameter die Antwort des Servers mit, um die Daten später anzeigen zu können. Im Fehlerfall gibt der Resolve ein false zurück, um eine Fehlermeldung im PaymentRequest auszulösen.
function verifyPaymentWithBackend(data) {
return new Promise((resolve, reject) => {
var xmlhttp = new XMLHttpRequest();
xmlhttp.onload = function() {
if (xmlhttp.status == 201) {
resolve(xmlhttp.responseText);
} else {
resolve(false)
}
};
xmlhttp.open("POST", "/payment");
xmlhttp.setRequestHeader("Content-Type", "application/json");
xmlhttp.send(JSON.stringify(data));
});
}
Schließlich wird die Methode showPaymentResponse(data) ausgeführt, die einige UI-Elemente verändert, um eine erfolgreiche Zahlung darzustellen. Um das Tutorial nicht unnötig kompliziert werden zu lassen, wurde auf eine Single-Page Application z.B. mit vue.js verzichtet. Ebenso existiert keine Nutzer-Authentifizierung, um eine Zahlung später einem bestimmten Benutzer zuzuordnen.
In der showPaymentResponse(data) wird der Text vom Produkt-Button von "Kaufen" in "Gekauft" geändert, außerdem dessen Hintergrund verändert und der Event Listener entfernt, um einen weiteren Kauf bis zum erneuten Laden der Seite zu verhindern. In der data_list wird anschließend das JSON-Objekt vom Server zurückgegeben, das die eingegebenen Daten des Benutzers enthält.
function showPaymentResponse(data) {
document.getElementById("produkt_button").innerHTML = 'Gekauft';
document.getElementById("produkt_button").style.backgroundColor = "#4CAF50";
document.getElementById("produkt_button").removeEventListener('click', handleProduktClick);
document.getElementById("produkt_bought").style.display = "block";
document.getElementById("data_list").innerHTML = data;
}
Wenn die index.html entsprechend definiert wurde, kann unter der URL localhost:8080 die Seite idealerweise im Browser Google Chrome aufgerufen werden.
Um ein PaymentRequest mit Lieferadresse und Versandoptionen zu bauen, muss der bestehende Code um einige weitere Methoden und Variablen ergänzt werden.
Zunächst einmal wird der CSS-Code um ein neue Element erweitert. Dies dient später der Anzeige, ob der Expressversand bei dem Produkt gewählt wurde oder nicht. Den folgenden Code in den Bereich zwischen <style> und </style> an eine beliebige Stelle einfügen.
#express_selected {
display:none;
}
Nun das <p>-Element
<p>Sie haben das Beispielprodukt erfolgreich für 49,99 € gekauft.</p>
um folgenden Code erweitern:
<p>Sie haben das Beispielprodukt erfolgreich für 49,99 € <span id="express_selected">(+ 14,99 € Expressversand)</span> gekauft.</p>
Das Array der paymentDetails im Javascript-Code wird jetzt um die Versandoptionen erweitert. Dazu den bisherigen Code
var paymentDetails = {
total: {label: 'Beispielprodukt', amount: {currency: 'EUR', value: '49.99'}}
};
durch folgenden Code ersetzen:
var paymentDetails = {
total: {label: 'Gesamtsumme', amount: {currency: 'EUR', value: '49.99'}},
displayItems: [
{
label: 'Beispielprodukt',
amount: {currency: 'EUR', value: '49.99'},
},
{
label: 'Standardversand',
amount: {currency: 'EUR', value: '0.00'},
}
],
shippingOptions: [
{
id: 'standard',
label: 'Standardversand',
amount: {currency: 'EUR', value: '0.00'},
selected: true
},
{
id: 'express',
label: 'Expressversand',
amount: {currency: 'EUR', value: '14.99'},
},
],
};
Zusätzlich wird in der Variable options der Wert von requestShipping auf true gesetzt, um die Abfrage einer Lieferadresse im PaymentRequest-Fenster zu aktivieren.
var options = {
requestShipping: true
};
Durch die neu hinzugekommene option muss auch die Instanz des PaymentRequest entsprechend erweitert werden von:
var paymentRequest = new PaymentRequest(supportedPaymentMethods, paymentDetails);
auf:
var paymentRequest = new PaymentRequest(supportedPaymentMethods, paymentDetails, options);
Nun wird direkt unter der Definition der Instanz eines PaymentRequest ein EventListener gesetzt, der überwacht ob sich die ausgewählte Lieferadresse ändert (Event: shippingoptionchange). Sollte dies der Fall sein, wird durch die updateWith()-Methode ein Promise definiert, der durch die updateDetails()-Methode aufgelöst wird.
paymentRequest.addEventListener('shippingoptionchange', function(evt) {
evt.updateWith(new Promise(function(resolve, reject) {
updateDetails(paymentDetails, paymentRequest.shippingOption, resolve, reject);
}));
});
Direkt darunter wird nun die updateDetails()-Methode definiert. In dieser wird geschaut, welche Versandoption der Benutzer ausgewählt hat. Bei kostenlosem Standardversand ändert sich der Endbetrag nicht, bei Auswahl von Expressversand müssen 14,99 Euro dazugerechnet werden. Im Fehlerfall soll der Promise abgelehnt werden (Unbekannte Versandart...). Wenn der Benutzer eine neue Versandoption auswählt, muss dies auch im PaymentRequest-Fenster abgebildet werden. Dazu werden die Versandoptionen mit der Funktion details.displayItems.splice(1, 2, selectedShippingOption); ausgetauscht, da immer nur eine Versandoption aktiv sein kann. Am Ende wird der Promise resolved und das Ergebnis an die updateWith()-Methode übergeben.
function updateDetails(details, shippingOption, resolve, reject) {
if (shippingOption === 'standard') {
selectedShippingOption = details.shippingOptions[0];
otherShippingOption = details.shippingOptions[1];
details.total.amount.value = '49.99';
} else if (shippingOption === 'express') {
selectedShippingOption = details.shippingOptions[1];
otherShippingOption = details.shippingOptions[0];
details.total.amount.value = '64.98';
} else {
reject('Unbekannte Versandart \'' + shippingOption + '\'');
return;
}
selectedShippingOption.selected = true;
otherShippingOption.selected = false;
details.displayItems.splice(1, 2, selectedShippingOption);
resolve(details);
}
Nun wird noch die showPaymentResponse()-Methode aktualisiert, um im Fall der ausgewählten Express-Versandoption den zusätzlichen Preis anzuzeigen. Dazu folgende Zeile einfügen:
if(data.shippingOption == "express") {
document.getElementById("express_selected").style.display = "inline-block";
}
Die ganze Funktion sieht dann so aus:
function showPaymentResponse(data) {
document.getElementById("produkt_button").innerHTML = 'Gekauft';
document.getElementById("produkt_button").style.backgroundColor = "#4CAF50";
document.getElementById("produkt_button").removeEventListener('click', handleProduktClick);
document.getElementById("produkt_bought").style.display = "block";
if(data.shippingOption == "express") {
document.getElementById("express_selected").style.display = "inline-block";
}
document.getElementById("produkt_bought").style.display = "block";
document.getElementById("data_list").innerHTML = JSON.stringify(data);
}
Damit sind alle Änderungen abgeschlossen und der PaymentRequest sollte jetzt die Auswahl einer Lieferadresse und einer Versandoption unterstützen. Nachfolgend nochmal der gesamte Code mit den Änderungen:
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>W3C Payment Request API Tutorial</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
* {
margin: 0;
}
html {
font-family: sans-serif;
line-height: 1.4;
padding: 2em;
}
body> :not(:first-child) {
margin-top: 1.5em;
}
h1,
h2 {
line-height: 1.15;
}
#express_selected {
display:none;
}
.produkt {
max-width: 13em;
padding: 1em;
background: #fff;
}
.produkt> :not(:first-child) {
margin-top: 0.85em;
}
.produkt_bought {
padding: 1em;
background: #fff;
}
.data_list {
max-width: 100%;
}
.produkt_bought> :not(:first-child) {
margin-top: 0.85em;
}
.produkt_bought {
display: none;
}
.produkt_shadow {
position: relative;
-webkit-box-shadow: 0 1px 4px rgba(0, 0, 0, 0.3);
box-shadow: 0 1px 4px rgba(0, 0, 0, 0.3);
}
.produkt_shadow:after {
content: "";
position: absolute;
z-index: -1;
-webkit-box-shadow: 0 0 40px rgba(0, 0, 0, 0.8);
box-shadow: 0 0 40px rgba(0, 0, 0, 0.8);
bottom: 0px;
left: 10%;
right: 10%;
width: 80%;
height: 50%;
-moz-border-radius: 100%;
border-radius: 100%;
}
.produkt_meta {
display: flex;
align-items: center;
justify-content: space-between;
}
.produkt_button {
background-color: #008CBA;
color: #fff;
padding: 0.25em 1em;
text-decoration: none;
}
</style>
</head>
<body>
<h1>W3C Payment Request API Tutorial</h1>
<p> Teil 1: Einfacher Payment Request </p>
<div class="produkt produkt_shadow" id="produkt">
<h2>Beispielprodukt</h2>
<p>Ich bin ein ganz tolles Produkt! Kauf mich!</p>
<div class="produkt_meta">
<strong class="produkt_preis">nur 49.99 €</strong>
<a href="#" id="produkt_button" class="produkt_button">Kaufen</a>
</div>
</div>
<div class="produkt_bought" id="produkt_bought">
<h2>Beispielprodukt gekauft!</h2>
<p>Sie haben das Beispielprodukt erfolgreich für 49,99 € <span id="express_selected">(+ 14,99 € Expressversand)</span> gekauft.</p>
<p>Ihre Daten:</p>
<div id="data_list"></div>
</div>
<script>
function handleProduktClick(e) {
e.preventDefault();
var creditCardPaymentMethod = {
supportedMethods: 'basic-card',
};
var supportedPaymentMethods = [creditCardPaymentMethod];
var paymentDetails = {
total: {label: 'Gesamtsumme', amount: {currency: 'EUR', value: '49.99'}},
displayItems: [
{
label: 'Beispielprodukt',
amount: {currency: 'EUR', value: '49.99'},
},
{
label: 'Standardversand',
amount: {currency: 'EUR', value: '0.00'},
}
],
shippingOptions: [
{
id: 'standard',
label: 'Standardversand',
amount: {currency: 'EUR', value: '0.00'},
selected: true
},
{
id: 'express',
label: 'Expressversand',
amount: {currency: 'EUR', value: '14.99'},
},
],
};
var options = {
requestShipping: true
};
var paymentRequest = new PaymentRequest(supportedPaymentMethods, paymentDetails, options);
paymentRequest.addEventListener('shippingoptionchange', function(evt) {
evt.updateWith(new Promise(function(resolve, reject) {
updateDetails(paymentDetails, paymentRequest.shippingOption, resolve, reject);
}));
});
function updateDetails(details, shippingOption, resolve, reject) {
if (shippingOption === 'standard') {
selectedShippingOption = details.shippingOptions[0];
otherShippingOption = details.shippingOptions[1];
details.total.amount.value = '49.99';
} else if (shippingOption === 'express') {
selectedShippingOption = details.shippingOptions[1];
otherShippingOption = details.shippingOptions[0];
details.total.amount.value = '64.98';
} else {
reject('Unbekannte Versandart \'' + shippingOption + '\'');
return;
}
selectedShippingOption.selected = true;
otherShippingOption.selected = false;
details.displayItems.splice(1, 2, selectedShippingOption);
resolve(details);
}
paymentRequest
.show()
.then(paymentResponse => {
return verifyPaymentWithBackend(paymentResponse).then((success) => {
if (success) {
showPaymentResponse(JSON.parse(success));
return paymentResponse.complete('success');
} else {
return paymentResponse.complete('fail');
}
});
})
.catch(err => {
console.log('Error:', err);
});
};
function showPaymentResponse(data) {
document.getElementById("produkt_button").innerHTML = 'Gekauft';
document.getElementById("produkt_button").style.backgroundColor = "#4CAF50";
document.getElementById("produkt_button").removeEventListener('click', handleProduktClick);
document.getElementById("produkt_bought").style.display = "block";
if(data.shippingOption == "express") {
document.getElementById("express_selected").style.display = "inline-block";
}
document.getElementById("data_list").innerHTML = JSON.stringify(data);
}
function verifyPaymentWithBackend(data) {
return new Promise((resolve, reject) => {
var xmlhttp = new XMLHttpRequest();
xmlhttp.onload = function() {
if (xmlhttp.status == 201) {
resolve(xmlhttp.responseText);
} else {
resolve(false)
}
};
xmlhttp.open("POST", "/payment");
xmlhttp.setRequestHeader("Content-Type", "application/json");
xmlhttp.send(JSON.stringify(data));
});
}
document.getElementById("produkt_button").addEventListener('click', handleProduktClick)
</script>
</body>
</html>