From 30a6580de3b80eb1108f31239b3b601e1de3a898 Mon Sep 17 00:00:00 2001 From: Peter Odding Date: Tue, 7 Jan 2014 08:31:05 -0100 Subject: [PATCH] Update documentation --- 404.html | 2 +- archives.html | 2 +- articles/continuous-delivery.html | 2 +- articles/debian-packages.html | 2 +- articles/pip-accel.html | 2 +- articles/prefill-registration.html | 2 +- articles/you-are-welcome.html | 2 +- author/berco-beute.html | 2 +- author/oscar-vilaplana.html | 2 +- author/peter-odding.html | 2 +- author/spyros-ioakeimidis.html | 2 +- authors.html | 2 +- categories.html | 2 +- category/agile.html | 2 +- category/devops.html | 2 +- category/general.html | 2 +- category/integration.html | 2 +- index.html | 235 ++++++++++++++++++++++++++--- pages/about.html | 2 +- pages/integration.html | 2 +- pages/page-not-found.html | 2 +- tags.html | 2 +- 22 files changed, 233 insertions(+), 44 deletions(-) diff --git a/404.html b/404.html index 5edee27..e9d4089 100644 --- a/404.html +++ b/404.html @@ -77,7 +77,7 @@

Page not found

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/archives.html b/archives.html index bb1e377..5494f4f 100644 --- a/archives.html +++ b/archives.html @@ -86,7 +86,7 @@

Archives for Paylogic developer portal

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/articles/continuous-delivery.html b/articles/continuous-delivery.html index 8f899d8..63da525 100644 --- a/articles/continuous-delivery.html +++ b/articles/continuous-delivery.html @@ -374,7 +374,7 @@

Comments

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/articles/debian-packages.html b/articles/debian-packages.html index 4b298d8..2ba64dc 100644 --- a/articles/debian-packages.html +++ b/articles/debian-packages.html @@ -333,7 +333,7 @@

Comments

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/articles/pip-accel.html b/articles/pip-accel.html index 8eba881..1741f0b 100644 --- a/articles/pip-accel.html +++ b/articles/pip-accel.html @@ -388,7 +388,7 @@

Comments

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/articles/prefill-registration.html b/articles/prefill-registration.html index 510b7fd..3f56538 100644 --- a/articles/prefill-registration.html +++ b/articles/prefill-registration.html @@ -264,7 +264,7 @@

Comments

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/articles/you-are-welcome.html b/articles/you-are-welcome.html index 4c6367f..4244d74 100644 --- a/articles/you-are-welcome.html +++ b/articles/you-are-welcome.html @@ -115,7 +115,7 @@

Comments

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/author/berco-beute.html b/author/berco-beute.html index b7a2336..4838e9b 100644 --- a/author/berco-beute.html +++ b/author/berco-beute.html @@ -109,7 +109,7 @@

You are welcome

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/author/oscar-vilaplana.html b/author/oscar-vilaplana.html index 09672b3..64d3229 100644 --- a/author/oscar-vilaplana.html +++ b/author/oscar-vilaplana.html @@ -111,7 +111,7 @@

Continuous Delivery

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/author/peter-odding.html b/author/peter-odding.html index 19c3bff..ff20b64 100644 --- a/author/peter-odding.html +++ b/author/peter-odding.html @@ -121,7 +121,7 @@

pip-accel: Accelerator for pip, the Python package manag

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/author/spyros-ioakeimidis.html b/author/spyros-ioakeimidis.html index ee64dd3..4de6d46 100644 --- a/author/spyros-ioakeimidis.html +++ b/author/spyros-ioakeimidis.html @@ -101,7 +101,7 @@

Prefill Registration Data

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/authors.html b/authors.html index a6dd306..c086a0e 100644 --- a/authors.html +++ b/authors.html @@ -125,7 +125,7 @@

Spyros Ioakeimidis (1 article)

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/categories.html b/categories.html index a36e74e..4a78ea9 100644 --- a/categories.html +++ b/categories.html @@ -78,7 +78,7 @@

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/category/agile.html b/category/agile.html index 25187af..18538b3 100644 --- a/category/agile.html +++ b/category/agile.html @@ -89,7 +89,7 @@

Articles in the Agile category

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/category/devops.html b/category/devops.html index 4bfb28f..cc4c45b 100644 --- a/category/devops.html +++ b/category/devops.html @@ -97,7 +97,7 @@

Articles in the DevOps category

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/category/general.html b/category/general.html index 412695a..a350120 100644 --- a/category/general.html +++ b/category/general.html @@ -89,7 +89,7 @@

Articles in the General category

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/category/integration.html b/category/integration.html index f2e3b57..b0cfd39 100644 --- a/category/integration.html +++ b/category/integration.html @@ -89,7 +89,7 @@

Articles in the Integration category

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/index.html b/index.html index f4207dd..b411c2c 100644 --- a/index.html +++ b/index.html @@ -66,34 +66,223 @@
-

Welcome

- +
+ +

Welcome

-

Introducing the Paylogic developer portal

-

Welcome to the Paylogic developer portal! This website is a platform for -communication between the engineers & devops at Paylogic and the world (you!). -We use this website to share:

-
    -
  • Articles about technical topics involving programming (testing, design, -architecture) and system administration (high availability, automation, -performance testing) and community events like PyGrunn
    • -
  • Open source projects we've published (see also our GitHub account)
    • -
  • How to integrate with Paylogic system.
    • -
-

In the future this website will also host the documentation of the Paylogic -ticketing API which is currently under development.

-
-

Recent articles

+

Introducing the Paylogic developer portal

+

Welcome to the Paylogic developer portal! This website is a platform for + communication between the engineers & devops at Paylogic and the world (you!). + We use this website to share:

+
    +
  • Articles about technical topics involving programming (testing, design, + architecture) and system administration (high availability, automation, + performance testing) and community events like PyGrunn
    • +
  • Open source projects we've published (see also our GitHub account)
    • +
  • How to integrate with Paylogic system.
    • +
+

In the future this website will also host the documentation of the Paylogic + ticketing API which is currently under development.

+
+ +
+
+

Latest article

+
+
+

+ + Prefill Registration Data + +

+
+ + + +

Paylogic offers a feature to allow the prefilling of the personal data of a +consumer during the sales process via a personalized URL. This can be used +whenever a merchant already has the data of the consumers and wants to offer +these consumers a more personalized and smooth ticketing process, or when a +pre-registration step is used. The following sections describe the steps that +third parties have to implement in order to provide the possibility of +prefilling the registration form in the front office.

+
+

JSON data format

+

The first step is to construct the data. The data should be structured using +JSON. The JSON data should adhere to the following format:

+
{
+  "first_name": "Test Client First Name",
+  "last_name": "Test Client Last Name",
+  "email": "test@testmail.com",
+  "gender": "1",
+  "birth_date": "1978-10-07",
+  "phone_number": "0123456789",
+  "address": "Address 1A",
+  "postal_code": "9999AB",
+  "city": "Groningen",
+  "country": "NL"
+}
+
+

The gender attribute should contain a code according to ISO 5218, which specifies the following +codes:

- +

The format of the birth_date attribute should be YYYY-MM-DD. +This format is according to ISO 8601. +Finally, the country code attribute should contain a value according to +ISO 3166. +For example, for The Netherlands the country code NL should be used. It +should be mentioned that no certain format is required for postal_code, +as long as its length is less than or equal to 12.

+
+
+

Compression and Encoding

+

The second step is to compress and encode the data. Compression helps to reduce +the length of the data, as the URL should contain up to a maximum number of +characters. It is not only that the JSON data itself might be long. Encoding +also increases the length of the data by approximately 33%.

+

The pseudo code below illustrates the process of encoding and compression. It +also includes the creation of the JSON data. The data should first be compressed +and then encoded.

+
+create the JSON data
+
+create a string out of the JSON data
+
+compress the data using gzip compatible compression
+
+encode the data using base64 and make them url safe
+
+

The way encoding and compression can be implemented depends on which programming +language is used. A simple implementation is illustrated both for Python and +PHP. If there are any questions regarding the implementation, then please contact +the Paylogic support team.

+
+

Python

+

The compression is done using the zlib +standard python module. The data is encoded to utf-8 prior to compression. Data +encoding is performed using base64 as specified in RFC 3548

+
import json
+import zlib
+
+from base64 import urlsafe_b64encode
+
+# construct the json data
+json_data = {"first_name": "Test Client First Name", ... }
+
+# create a string of the json data
+json_data_string = json.dumps(json_data)
+
+# encode the data to utf8 and compress it
+compressed_data = zlib.compress(json_data_string.encode('utf8'))
+
+# encode the data using base64 and urlsafe
+encoded = urlsafe_b64encode(compressed_data)
+
+
+
+

PHP

+

The compression is done using the gzcompress +method, which uses the zlib data format. The data is +encoded to utf-8 prior to compression. Data encoding is performed using base64 +as specified in RFC 3548

+
<?php
+# create a string of the json data
+$json_data_string = '{"first_name": "Test Client First Name", ... }';
+
+# encode data to utf8 and compress it
+$compressed_data = gzcompress(utf8_encode($json_data_string));
+
+# encode the data using base64
+$encoded_data = base64_encode($compressed_data);
+
+# make data urlsafe
+$encoded_data = str_replace(array('+','/'), array('-','_'), $encoded_data);
+?>
+
+
+
+

Transferring the data

+

The third step is to append the encoded and compressed data to the landing page +URL. The landing page URL is the URL that is usually included within the +invitation emails. The encoded and compressed data should be appended to the +landing page URL after the fragment identifier (#). The advantage of +this approach is that data after the fragment identifier is not sent over the +network and is only used client-side.

+

The implementation of this is left to the third parties. The only constraint is +that the appended data should have a specific form. We assume that the landing +page URL contains some query parameters (substituted with '...' in the +following example for clarity) and FGRAhdfhasAHDFA is the encoded and +compressed data. Then, a landing page URL with the appended data would have the +following form:

+
+http://tickets.company.com/?...#pld=FGRAhdfhasAHDFA
+
+

It is important to use pld as a parameter, as this is also used on the +side of Paylogic, when retrieving the data from the URL. The above method will +work if Paylogic handles the creation of the landing page.

+
+

Third party handles landing page

+

In case a third party handles the creation of the landing page, then one more +step needs to be performed. The Javascript code below should be appended at the +end of the landing page HTML document. This ensures that the data is read from +the landing page URL and that it is appended in the queue URL, which resides as +an iframe inside the landing page HTML document.

+
<script type="text/javascript">
+var getHashParam = function() {
+  window.location.hash.replace(/([^#&]+)/g, function(match) {
+    // This is to ensure that if the variable contains '=' then they remain in the value.
+    // for example: pld=FHadfsdhFJASDF3423==
+    // In this case:
+    //   key: pld
+    //   value: FHadfsdhFJASDF3423==
+    var param = match.split(/=(.+)?/);
+    if (param[0] === "pld") {
+        queue = document.getElementById('paylogic-frontoffice');
+        queue.src = queue.src + '#' + param[0] + '=' + param[1];
+    }
+  });
+};
+getHashParam();
+</script>
+
+
+
+
+
+ +
+ +
@@ -101,7 +290,7 @@

Recent articles

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/pages/about.html b/pages/about.html index 0edb166..9cc5df3 100644 --- a/pages/about.html +++ b/pages/about.html @@ -105,7 +105,7 @@

About Paylogic International

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/pages/integration.html b/pages/integration.html index a27acca..ee94ab3 100644 --- a/pages/integration.html +++ b/pages/integration.html @@ -88,7 +88,7 @@

Articles

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/pages/page-not-found.html b/pages/page-not-found.html index 5edee27..e9d4089 100644 --- a/pages/page-not-found.html +++ b/pages/page-not-found.html @@ -77,7 +77,7 @@

Page not found

- Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

diff --git a/tags.html b/tags.html index 7580ebb..86e0900 100644 --- a/tags.html +++ b/tags.html @@ -87,7 +87,7 @@

Tags for Paylogic developer portal

  • - Copyright (c) 2013 Paylogic, + Copyright (c) 2014 Paylogic, built using the awesome Pelican static site generator.
    This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.