Skip to content

Home

Jump to bottom
Piotr Zerynger edited this page Nov 12, 2021 · 6 revisions

PSD2 PolishAPI 3.0 sandbox

This is a sample sandbox implementation of PSD2 Polish API 3.0 version.

This project is intended for educational purposes only. No commercial or production use.

This sandbox is currently running on Google Cloud here: [PolishAPI 3.0 Sandbox](https://polishapi-psd2.appspot.com/swagger-ui.html) Anybody can can call PSD2 sandbox services free of charge, creating own client applications, for example Android apps. If anybody wants more implemented services please ask me.

In my opinion, complete, tested and fully functional PSD2 PolishAPi 3.0 sandbox can be developed by two programmers in no more than four to six weeks.

Getting Started

In this case study I tried to get the best from Swagger code generator and the best software engineering practicies to obtain a maintainable project. Main patterns I used are Delegation, Loose Coupling, Separation of Responsibilities and others.

Prerequisites

  • JDK 11
  • swagger-codegen
  • maven
  • MongoDB
  • PolishAPI
  • curl or curl for windows currently valid token: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*

Getting Started

After installing jdk 11 and Maven you should check minimal system requirements, simply run:

{workspace_path}>mvn --version

you should receive something like this:

Java HotSpot(TM) 64-Bit Server VM warning: Ignoring option MaxPermSize; support was removed in 8.0 Apache Maven 3.6.0 (97c98ec64a1fdfee7767ce5ffb20918da4f719f3; 2018-10-24T20:41:47+02:00) Maven home: D:\maven\apache-maven-3.6.0\bin.. Java version: 11.0.2, vendor: Oracle Corporation, runtime: C:\Program Files\Java\jdk-11.0.2 Default locale: pl_PL, platform encoding: Cp1252 OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

Pull swagger:

{workspace_path}\swagger>git clone https://github.com/swagger-api/swagger-codegen.git

in my case I had to modify the {workspace_path}\swagger\swagger-codegen\modules\swagger-generator\pom.xml file adding this dependencies:

<dependency> <groupId>javax.xml.bind</groupId> <artifactId>jaxb-api</artifactId> <version>2.2.11</version> </dependency> <dependency> <groupId>com.sun.xml.bind</groupId> <artifactId>jaxb-core</artifactId> <version>2.2.11</version> </dependency> <dependency> <groupId>com.sun.xml.bind</groupId> <artifactId>jaxb-impl</artifactId> <version>2.2.11</version> </dependency> <dependency> <groupId>javax.activation</groupId> <artifactId>activation</artifactId> <version>1.1.1</version> </dependency>

In the folder you installed swagger go to swagger-codegen folder:

{workspace_path}\swagger>cd swagger-codegen

and then build swagger codegen:

{workspace_path}\swagger\swagger-codegen>mvn clean package -DskipTests

tests fail in the swagger version I installed on my Win10pro, so I skipped them.

Is good to know and understand all possible swagger codegen parameters for spring. Download the > ZBP-polish-api-3_0-swagger.json file from PolishAPI. In polishAPI_Options.json file I created, I included some parameters for swagger codegen. The most important are:

{ ..... "dateLibrary": "java8", "java8": "true", "delegatePattern": "true", "bigDecimalAsString": "true", "useTags": "true", "serializableModel": "true" }

Next step is to generate the spring-boot server:

java -jar {workspace_path}\swagger\swagger-codegen\modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i {workspace_path}\polishAPI\ZBP-polish-api-3_0-swagger.json -l spring -c {workspace_path}\polishAPI\polishAPI_Options.json

Next, in NetBeans (or any other IDE), create a New Project/Maven/Project with Existing POM. Because I configured swagger-codegen with "delegatePattern": "true", after successful generation in previous step, I wrote classes that implemented

AisApiDelegate, AsApiDelegate, CafApiDelegate, PisApiDelegate interfaces.

In that classes I am implementing the business logic for all services. Start your server as an simple java application. You can view the PolishAPI documentation in swagger-ui by pointing to https://localhost:8443/ or directly to PolishAPI 3.0 Sandbox

I opted for MongoDB as data base, to fill mongo with fake data you should execute the following command: curl -X POST https://localhost:8443//makeFakeData

this way, we generate RANDOM fake data.

When spring started, you can test its functionality. The best is using curl, for example:

curl -k -v POST "https://localhost:8443/v3_0.1/accounts/v3_0.1/getAccounts" -H "accept: application/json" -H "Accept-Charset: utf-8" -H "Accept-Encoding: gzip" -H "Accept-Language: PL-pl" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTgwMDgxMzUxLCJyb2wiOlsiSGVsbG8iLCJXb3JsZCJdLCJuYW1lIjoiY2xpZW50X2lkIiwic2NvcGUiOiJpdGdlcl9wb2xpc2hBUElfMl8xXzIifQ.qT9rDGy3NsXmKYZuUTcMBlbYHC7d2REBJ9ueumVhefE*" -H "X-JWS-SIGNATURE: wefewfef" -H "X-REQUEST-ID: 95215B80-A744-11E9-B4AB-D922C8858915" -H "Content-Type: application/json" -d "{ \"perPage\":\"2\", \"pageId\": \"0\", \"requestHeader\": { \"ipAddress\": \"string\", \"isDirectPsu\": true, \"requestId\": \"95215B80-A744-11E9-B4AB-D922C8858915\", \"sendDate\": \"2019-10-15T20:59:12.601Z\", \"tppId\": \"string\", \"userAgent\": \"string\", \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTgwMDgxMzUxLCJyb2wiOlsiSGVsbG8iLCJXb3JsZCJdLCJuYW1lIjoiY2xpZW50X2lkIiwic2NvcGUiOiJpdGdlcl9wb2xpc2hBUElfMl8xXzIifQ.qT9rDGy3NsXmKYZuUTcMBlbYHC7d2REBJ9ueumVhefE*\" }}

the query predicates must be in accordance with generated data.

Sample invocations:

getAccounts

curl -k -v -X POST "https://polishapi-psd2.appspot.com/v3_0.1/accounts/v3_0.1/getAccounts" -H "accept: application/json" -H "Accept-Charset: utf-8" -H "Accept-Encoding: gzip" -H "Accept-Language: PL-pl" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*" -H "X-JWS-SIGNATURE: wefewfef" -H "X-REQUEST-ID: 95215B80-A744-11E9-B4AB-D922C8858915" -H "Content-Type: application/json" -d "{ \"requestHeader\": { \"ipAddress\": \"string\", \"isDirectPsu\": true, \"requestId\": \"95215B80-A744-11E9-B4AB-D922C8858915\", \"sendDate\": \"2019-10-15T20:59:12.601Z\", \"tppId\": \"PSDPL-ABCD-0123456789\", \"userAgent\": \"string\", \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*\" }}

getAccounts with paging functionality (“perPage”:”2″):

curl -k -v -X POST "https://polishapi-psd2.appspot.com/v3_0.1/accounts/v3_0.1/getAccounts" -H "accept: application/json" -H "Accept-Charset: utf-8" -H "Accept-Encoding: gzip" -H "Accept-Language: PL-pl" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*" -H "X-JWS-SIGNATURE: wefewfef" -H "X-REQUEST-ID: 95215B80-A744-11E9-B4AB-D922C8858915" -H "Content-Type: application/json" -d "{ \"perPage\":\"2\", \"requestHeader\": { \"ipAddress\": \"string\", \"isDirectPsu\": true, \"requestId\": \"95215B80-A744-11E9-B4AB-D922C8858915\", \"sendDate\": \"2019-10-15T20:59:12.601Z\", \"tppId\": \"PSDPL-ABCD-0123456789\", \"userAgent\": \"string\", \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*\" }}

In this response you can see the previous and next page info:

… "pageInfo": { "previousPage": "UFJFVg5e0943e79d932978be0f9349", "nextPage": "TkVYVA5e0943e79d932978be0f934a" }:

next page invocation:

curl -k -v -X POST "https://polishapi-psd2.appspot.com/v3_0.1/accounts/v3_0.1/getAccounts" -H "accept: application/json" -H "Accept-Charset: utf-8" -H "Accept-Encoding: gzip" -H "Accept-Language: PL-pl" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*" -H "X-JWS-SIGNATURE: wefewfef" -H "X-REQUEST-ID: 95215B80-A744-11E9-B4AB-D922C8858915" -H "Content-Type: application/json" -d "{ \"perPage\":\"2\", \"pageId\": \"TkVYVA5e0943e79d932978be0f934a\", \"requestHeader\": { \"ipAddress\": \"string\", \"isDirectPsu\": true, \"requestId\": \"95215B80-A744-11E9-B4AB-D922C8858915\", \"sendDate\": \"2019-10-15T20:59:12.601Z\", \"tppId\": \"PSDPL-ABCD-0123456789\", \"userAgent\": \"string\", \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*\" }}

getting specific account:

curl -k -v -X POST "https://polishapi-psd2.appspot.com/v3_0.1/accounts/v3_0.1/getAccount" -H "accept: application/json" -H "Accept-Charset: utf-8" -H "Accept-Encoding: gzip" -H "Accept-Language: PL-pl" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*" -H "X-JWS-SIGNATURE: wefewfef" -H "X-REQUEST-ID: 95215B80-A744-11E9-B4AB-D922C8858915" -H "Content-Type: application/json" -d "{ \"accountNumber\": \"4006-9633-1698-9248\", \"requestHeader\": { \"ipAddress\": \"string\", \"isDirectPsu\": true, \"requestId\": \"95215B80-A744-11E9-B4AB-D922C8858915\", \"sendDate\": \"2019-10-15T20:59:12.601Z\", \"tppId\": \"PSDPL-ABCD-1234567890\", \"userAgent\": \"string\", \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*\" }}"

Holds on specified account:

curl -k -v -X POST "https://polishapi-psd2.appspot.com/v3_0.1/accounts/v3_0.1/getHolds" -H "accept: application/json" -H "Accept-Charset: utf-8" -H "Accept-Encoding: gzip" -H "Accept-Language: PL-pl" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*" -H "X-JWS-SIGNATURE: wefewfef" -H "X-REQUEST-ID: 95215B80-A744-11E9-B4AB-D922C8858915" -H "Content-Type: application/json" -d "{ \"perPage\":\"4\", \"minAmount\":\"15000.00\", \"requestHeader\": { \"ipAddress\": \"string\", \"isDirectPsu\": true, \"requestId\": \"95215B80-A744-11E9-B4AB-D922C8858915\", \"sendDate\": \"2019-10-15T20:59:12.601Z\", \"tppId\": \"PSDPL-ABCD-0123456789\", \"userAgent\": \"string\", \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vaXRnZXIucGwvIiwic3ViIjoic3ViamVjdCIsImF1ZCI6ImF1ZGllbmNlIiwiZXhwIjoxNTg1NzQ1MDEwLCJyb2wiOlsiUm9sMSIsIlJvbDIiXSwibmFtZSI6ImNsaWVudF9pZCIsInNjb3BlIjoiaXRnZXJfcG9saXNoQVBJXzJfMV8yIn0.Nqqc37-svsjtKyjww1x92PCHlFsfbG6gP3iGnUdg-p0*\" }}

*** work in progress ***

Clone this wiki locally