Quickstart connection to API

Quick start - no unnecessary introductions and documentation. Here we go!

Quickstart tells about:

  • Application creation in API Panel.
  • Example installation from GitHub.
  • Run the example.
  • Test the API on-line.


Configuration on the API Panel side

  • Create an account on our website https://panel.transactionlink.io/register
  • Create a new application, fill in its details.

  • After creating, click on the application

  • In the application details, the "Developers" menu, there is the "Secret code" of your application. Identifies your application when connecting to our API. It'll be needed in a moment.

Example installation from GitHub

The example is written in python (flask). I will assume you have python installed. if not: link to install python. You clone/copy a ready example from github, set a secret-code and run it. Below Windows/Linux commands.
                                  git clone https://github.com/transactionlink/examples_api.git
                                  cd examples_api
                                  python -m venv venv
                                
For Windows:
                                    venv/Scripts/activate.bat
                                
And the same for Linux:
                                  source venv/bin/activate
                                
Next for Windows and Linux:
                                  pip install -r requirements.txt
                                    cd banks_list
                                

You enter secret code in the .flaskenv file from the panel



Launch your application

  • Go to the application source folder: examples_api/banks_list
  • Run flask application:
                              flask run
                            
  • You run the application in the browser. You are now a banking customer using your app.


  • After clicking on the button (the last button is one line of code to be pasted on the page), the list of banks to which the customer can log in will be opened (during the tests, you can only log in to the Alior Bank sandbox). Clicking on any of the icons will open the bank login screen.

  • Bank login page. Login: 22058375, hasło: 12345678


  • I select one or two accounts


  • After granting the permission, the banking client will be redirected to the page you set in the Panel. If the "thank you" page has not been set, our page will be displayed by default.


    You can change the redirect URL to the "thanks" page in the API Panel, Developers menu, at the bottom of the page.

  • After the bank customer has granted permission to read his account (in accordance with PSD2), you can start asking the API. For a complete list of API capabilities, see the documentation. You use the secret-code of your Application and the identifier of a specific client. In our example, the client ID (client ref) was displayed on the terminal:


Try other API functions

Go to the website https://sandbox.transactionlink.io/ui/ and you will see all the endpoints of our API along with the possibility of testing them online.
To run on-line tests, you first need to authorize yourself. Click on "Authorize" and paste the "secret code" of your application (instead of zeros on the screen)




To get list of client's transactions you need:
                      /account-information-service/clients/{client_id}/transactions
                    



Click "Try it out"


Fill in the client ID (e.g. the one that the application returned, clientRef) and click "Execute"


In return, we receive a transaction list


You can run other endpoints similarly. When calling, you also have an example of a universal request in the form of curl.