Allow users to navigate from a connected Account Servicer’s Application into your Application whilst maintaining context.

A key benefit of having your App as part of a Tapico powered ecosystem is Single Sign-on (SSO). In addition to SSO, Tapico’s API also allows you to identify either the Customer or Account that the user was viewing within the Account Servicer’s application before they navigated to your App. Depending on the functionality of your App, you can take this identifier to look up the specific Customer or Account and direct the user to the relevant page in your App. Maintaining the context for the user as they move between applications.

The steps to implement carrying context for your App are detailed below. NOTE: This only applies to Apps that are approved to be a part of an Account Servicer’s App Store/Marketplace.


1. Obtaining the context - The context query string parameter

After a user has subscribed to your App they will be able to open it from the launchpad within the Account Servicer's application.

When the user clicks “Go to App” they are directed to the “Landing Page URL” configured against your Application

A context query string parameter is appended to this URL. An example with the demo FIRE Calculator App is below:

https://fire.sandbox.tapico.cloud/sso?accountServicerId=98a9a9cc-a4c0-4a87-92ca-451f094941b1&context=eyJjdXN0b21lcklkIjoiMDE1LTAwMDAzNTI2MDcifQ%3D%3D

The context query string parameter is base64 encoded and contains an identifier representing the type of entity the user was in the context of when they clicked “Go to App”

2. Decoding the context query string parameter

Once the context query string parameter has been base64 decoded you will have a simple JSON object which contains the type of identifier and the identifier itself. For example:

{"customerId":"015-0000352607"}

Currently only two types of identifiers are supported - customerId and accountId. These relate to specific Tapico API endpoints.

3. Using the context to retrieve the associated entity data

Now that you have extracted the identifier from the context parameter you can make a request to the Tapico API to retrieve the data for that entity.

accountId:

GET /authorising-users/{{authorisingUserId}}/accounts?externalId={{identifier}}

customerId:

GET /authorising-users/{{authorisingUserId}}/customers?externalId={{identifier}}

You will need logic on the page which you have configured as the “Landing Page URL” which can extract the context parameter and then do the lookup for the associated entity.

This can then be used to navigate the user directly to a location in your Application relevant to that entity e.g. instead of the user landing on a generic “dashboard” type page when they are redirected to your Application you can send them to a page which contains the details of the customer.