Run QuickStart App

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:

  1. Obtain your API keys for the sandbox or production to authenticate API requests
  2. Install Node JS and run the QuickStart app
  3. 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 developers@friendlyscore.com or speak directly with us on LiveChat.

Authentication

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.

Installing the QuickStart application

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:
1 node -v

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:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 # Begin by cloning the following GitHub repository git clone https://github.com/FriendlyScore/FriendlyScore-Quickstart-NodeJS-Example.git # Go to the downloaded directory cd FriendlyScore-Quickstart-NodeJS-Example # Install NodeJS modules npm install # Set the host and port of the QuickStart app export LISTEN_PORT=3000 export LISTEN_HOST=127.0.0.1 # Set user reference. This will be used to identify the user. export USER_REFERENCE='YOUR_USER_REFERENCE' # Point base URL to FriendlyScore Sandbox API export BASE_URL='https://sandbox.friendlyscore.com' # Set client Id and client secret with your Sandbox API keys from the Dashboard # (Your API keys can be found at https://friendlyscore.com/company/keys) export CLIENT_ID='YOUR_CLIENT_ID' export CLIENT_SECRET='YOUR_CLIENT_SECRET' # Start the Node App and go to http://127.0.0.1:3000 node index.js

Using the QuickStart App

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:

NameDescription
Bank TransactionsAccess bank transaction data and classification for all major UK banks through a single API.
InsightsAccess to a library of metrics which summarise, describe and extract insights from Open Banking data.
ForecastsFull credit risk solution and liquidity forecast.

Data dictionaries are available for Transactions, Insights and Forecasts.

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)