From 1e36811c2e084704248c466b9927d29512b696d1 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Fri, 6 Nov 2020 23:49:35 +0100 Subject: rework intro --- taler-merchant-api-tutorial.rst | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) (limited to 'taler-merchant-api-tutorial.rst') diff --git a/taler-merchant-api-tutorial.rst b/taler-merchant-api-tutorial.rst index 39cf36da..7f371f0c 100644 --- a/taler-merchant-api-tutorial.rst +++ b/taler-merchant-api-tutorial.rst @@ -40,8 +40,12 @@ regulation (such as GDPR). About this tutorial ------------------- -This tutorial addresses how to process payments using the GNU Taler -merchant Backend. This chapter explains some basic concepts. In the +This tutorial addresses how to process payments using the GNU Taler merchant +Backend. The audience for this tutorial are *developers* of merchants (such +as Web shops) that are working on integrating GNU Taler with the +customer-facing Frontend and the staff-facing Backoffice. + +This chapter explains some basic concepts. In the second chapter, you will learn how to do basic payments. This version of the tutorial has examples for Python3. It uses the @@ -51,18 +55,23 @@ languages/environments are available as well. If you want to look at some simple, running examples, check out these: - The `essay - merchant `__ + merchant `__ that sells single chapters of a book. - The `donation - page `__ + page `__ that accepts donations for software projects and gives donation receipts. - The - `survey `__ + `survey `__ that gives users who answer a question a small reward. +- The `WooCommerce plugin `__ + which is a comprehensive integration into a Web shop including the refund business + process. + + Architecture overview --------------------- @@ -97,9 +106,11 @@ with the exchange, and also does not deal with sensitive data. In particular, the merchant’s signing keys and bank account information are encapsulated within the Taler backend. -Some functionality of the backend (the “public interface“) is also -exposed to the customer’s browser directly. In the HTTP API, all public -endpoints are prefixed with ``/public/``. +Some functionality of the backend (the “public interface“) is exposed to the +customer’s browser directly. In the HTTP API, all private endpoints (for the +Backoffice) are prefixed with ``/private/``. This tutorial focuses on the +``/private/`` endpoints. The public interface is directly used by the wallet +and not relevant for the merchant (other than that the API must be exposed). .. index:: sandbox, authorization @@ -108,7 +119,7 @@ Public Sandbox Backend and Authentication ----------------------------------------- How the frontend authenticates to the Taler backend depends on the -configuration. See Taler Merchant Operating Manual. +configuration. See `GNU Taler Merchant Backend Operator Manual`. The public sandbox backend https://backend.demo.taler.net/ uses an API key in the ``Authorization`` header. The value of this header must be -- cgit v1.2.3