The purpose of this lab is:
|
|
Backend calls (a.k.a. backend queries) are commonplace and essential to unlock the power of CIAM. Ubisecure CustomerID is used by organisations to allow every person (customers and employees) create and manage their own identities. Today nearly every Internet service connects with third party services to enrich the customers' data.
Example: Buying a physical product on an online store
When you go to the shopping cart you fill in some details. Once you enter your delivery address, the ecommerce service will make a backend call to a third party service (e.g. Postal Service) to verify that the address is correct. If not correct, the online store will either pre-fill the right information or show you a warning so you correct the address. This avoids that your product is sent to an address that doesn't exist.
The same idea of backend calls occurs in registration workflows. In a user registration workflow, you can use a backend call to:
Now it's time to get familiar with some basics about backend calls. During lab 2.2 (IAM Academy 4), you already configured a self-registration workflow. This will be a similar workflow with the following changes:
a- Company number verification, and
b- The approval is automated (in lab 2.2 is done manually)
The diagram below shows the main steps on this lab.
In order to call third party service VIES, first you need to install Internet Information Services and ASP.NET.
Can't CustomerID call directly to VIES API? In most real scenarios we need such proxy, in order to translate the data between the third party API and the CIAM system. |
Now it's time to install the application that will process the backend calls.
VIES (VAT Information Exchange System) is an electronic mean of validating VAT-identification numbers of economic operators registered in the European Union for cross border transactions on goods or services. http://ec.europa.eu/taxation_customs/vies/ File queryvies.asp is a simple script that allows us to call VIES service, and obtain organisation name and registered postal address |
Copy given file queryvies.asp to "C:\inetpub\wwwroot"
In order to verify that queryvies.asp works, open it on a browser adding valid parameters. For instance, http://localhost:81/queryvies.asp?country=FI&vat=17487214 will give the following output:
Now that the service is up and running, we can configure CustomerID. We will create a new self-registration workflow on CustomerID that will make backend calls to VIES service.
For more detailed instructions how to configure backend queries, read the documentation on Developer Portal:
Backend query configuration - CustomerID
Create backend.properties file on C:\Program Files\Ubisecure\customerid\application\custom
backend.properties
|
Edit eidm2.properties according to backend.properties. Add the following section:
eidm2.properties
|
Now edit C:\Program Files\Ubisecure\customerid\application\custom\messages_en.properties to customise the labels in both the registration workflow and self-service user interface. Add the following lines to messages_en.properties
user.eurocompanyid = VAT number user.country = Country user.userorgname= Organization Name user.orgaddress = Registered Address registration.euorganization.input.user.country.tooltip = Tooltip 1 registration.euorganization.input.user.eurocompanyid.tooltip = Tooltip 2 |
(Optional) If you wish, you can also edit the labels in Finnish. Below a starting point for the customisation. You need to edit configuration file C:\Program Files\Ubisecure\customerid\application\custom\messages_fi.properties
messages_fi.properties
user.eurocompanyid = VAT-numero user.country = Maa user.userorgname= Organisaatio user.orgaddress = Osoite |
Finally, restart Wildfly
*** END OF EXERCISE ***
Backend queries documentation on Developer Portal:
Backend query configuration - CustomerID