- Set Allowed Origins in Developer panel
- Retrieve access token
- Embed WebComponent to your website
Once the steps are completed the customer journey will look as follows:
Below you can find code that integrates Planky's Web Component on your website. Both front and back end code is provided. To begin, simply select the language you wish to work in (on the left) then hit "Edit". This will open a new window in codesandbox.io where you can live test the code and view its output.
In the following, we provide a detailed step-by-step guide to integrating the WebComponent software into your website
By default, WebComponent origin is set to localhost on port 3000. If you want to run WebComponent on a different host and port you must set a new origin in the Developer Console.
To use the Planky API you need to authorise yourself. You can do that by retrieving access token by using your client_id and client_secret. The example below shows you how to make a request to obtain an access token. The token is needed to make authorised requests to the server. The API requests example will be perform using cURL.
Obtain your client_id and client_secret from Planky API keys.
Invalid client_id or client_secret
A one-time url is used to render the Planky WebComponent inside HTML.
|400 Bad Request||user_reference, ip, user_agent, origin is invalid or missing.|
|401 Unauthorized||access_token is invalid or expired.|
Follow the two simple steps to embed WebComponent:
- Create an HTML element with id fs-component to control the location where the component will be displayed
You can copy the template below and paste into your html page.
Events are triggered in the following situations:
|startFsComponentProcess||WebComponent loads the first view of the flow process.|
|endFsComponentProcess||WebComponent loads the last view of the flow process.|
|FsOpenBankingBankConnected||User successfully connects with the bank.|
Was this article helpful?
Friendly Score UK Ltd.
42 Brook Street, Mayfair
London W1K 5DB
Call us on +44 20 3709 6726
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)