In the following, we will detail the steps to follow to begin running the demo application in the sandbox environment. The application will allow you to test connectivity, call dummy data from a test bank, and fully interact with the FriendlyScore API.
Before we begin, make sure you have created a FriendlyScore account. To set up the QuickStart app, we need to complete the following steps:
- Obtain your API keys for the sandbox or production to authenticate API requests
- Install Node JS and run the QuickStart app
- Complete the customer journey for demo bank and make API requests
The following will guide you through this process, but if at any time you get stuck or need a hand, you can contact us via email at email@example.com or speak directly with us on LiveChat.
To authenticate requests to the API, we first need to obtain a set of API keys for the sandbox or production environment.
Your client_id and client_secret are sensitive and should be kept secure. Don't share them with anyone (not even with us!)
Your API keys are accessible via the Dashboard in the Developer section.
The following steps will guide you through the installation of the QuickStart application onto your computer.
- Open a command line interface on your computer (this is terminal on OSX, cmd.exe on Windows, or the Linux shell)
- QuickStart will run in NodeJS. Run the following command to check this is installed on your system:
If installed, the version of NodeJS (for example v14.17.0 ) will be displayed. Otherwise, download and install the latest version of NodeJS.
To install the QuickStart application, execute the below sequence of commands in your CLI:
The first step is to select the bank (for the sandbox environment the FS Demo Bank will be the only bank enabled). This will take you to the main screen of the application where we can begin making API requests.
The API itself is divided into three sections, each of which can be called by clicking the respective Send Request button:
|Bank Transactions||Access bank transaction data and classification for all major UK banks through a single API.|
|Insights||Access to a library of metrics which summarise, describe and extract insights from Open Banking data.|
|Forecasts||Full credit risk solution and liquidity forecast.|
Was this article helpful?
Friendly Score UK Ltd.
52 Brook Street 1st Floor, Mayfair
London W1K 5DS
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: 781963)