{"id":22969292,"url":"https://github.com/simonhauck/unofficial-nordigen-api-java","last_synced_at":"2025-08-13T11:32:38.583Z","repository":{"id":45216538,"uuid":"417949887","full_name":"simonhauck/unofficial-nordigen-api-java","owner":"simonhauck","description":"Unofficial Nordigen Banking Api to retrieve account information","archived":false,"fork":false,"pushed_at":"2021-12-30T23:00:57.000Z","size":476,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-11T12:37:34.820Z","etag":null,"topics":["banking","nordigen","open-banking","psd2"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simonhauck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-16T21:14:06.000Z","updated_at":"2021-12-30T23:00:54.000Z","dependencies_parsed_at":"2022-07-30T08:38:01.509Z","dependency_job_id":null,"html_url":"https://github.com/simonhauck/unofficial-nordigen-api-java","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonhauck%2Funofficial-nordigen-api-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonhauck%2Funofficial-nordigen-api-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonhauck%2Funofficial-nordigen-api-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonhauck%2Funofficial-nordigen-api-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simonhauck","download_url":"https://codeload.github.com/simonhauck/unofficial-nordigen-api-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229759804,"owners_count":18119870,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["banking","nordigen","open-banking","psd2"],"created_at":"2024-12-14T21:35:17.843Z","updated_at":"2024-12-14T21:35:18.473Z","avatar_url":"https://github.com/simonhauck.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unofficial Nordigen Api (Java)\n[![Manual workflow](https://github.com/simonhauck/unofficial-nordigen-api-java/actions/workflows/manual.yml/badge.svg)](https://github.com/simonhauck/unofficial-nordigen-api-java/actions/workflows/manual.yml)\n[![](https://jitpack.io/v/simonhauck/unofficial-nordigen-api-java.svg)](https://jitpack.io/#simonhauck/unofficial-nordigen-api-java)\n\n\nThis project provides a generated java api for\nthe [Nordigen](https://nordigen.com/en/account_information_documenation/api-documention/overview/) Banking Api which is\nspecified [here](https://ob.nordigen.com/api/swagger.json).\n\n## Modification\nThe api.yaml is modified to resolve some short comings. \n- Path and UUID objects were replace to strings. Some default values were invalid which lead to exceptions\n- Some methods returned void. In these cases now the raw string response is returned\n- Enums don't include a description. This lead to parsing errors with enums\n\n\n## Usage\n1. This project is provided via `https://jitpack.io`. Add the registry to your `build.gradle`, `pom` or `build.gradle.kts`\nExample `build.gradle`\n````shell\nrepositories {\n  ...\n  maven { url 'https://jitpack.io' }\n}\n````\n2. Add the dependecy\n````shell\nimplementation 'com.github.simonhauck:unofficial-nordigen-api-java:2.0.1' \n````\n\n## Basic Setup\nWith version 2.0 of the api the static api key was removed and users have to request now a dynamic token. The setup for this is slightly more complicated but below is an example in Kotlin and SpringBoot. I hope this gets you started :)\n\n1. Create two api clients, one with and one without authentication. The authentication interceptor is implemented in step 3. \n````kotlin\n@Configuration\nclass NordigenClientConfiguration {\n\n    @Bean(name = [\"NordigenWithAuth\"])\n    fun createNordigenClientWithAuth(\n        @Value(\"\\${nordigen.url}\") url: String,\n        nordigenApiKeyInterceptor: NordigenApiKeyInterceptor,\n    ): ApiClient {\n        return ApiClient().apply {\n            basePath = url\n            addAuthorization(\"NordigenToken\", nordigenApiKeyInterceptor)\n        }\n    }\n\n    @Bean(name = [\"NordigenNoAuth\"])\n    fun createNordigenClientNoAuth(@Value(\"\\${nordigen.url}\") url: String): ApiClient {\n        return ApiClient().apply { basePath = url }\n    }\n    \n    // ...\n }\n````\n\n2. Create you required clients. The NordigenTokenApi client does not required authentication. All other clients require the authentication\n````kotlin\n@Configuration\nclass NordigenClientConfiguration {\n    \n    @Bean\n    fun createNordigenAgreementsApi(@Qualifier(\"NordigenWithAuth\") client: ApiClient): AgreementsApi {\n        return client.buildClient(AgreementsApi::class.java)\n    }\n\n    @Bean\n    fun createNordigenTokenApi(@Qualifier(\"NordigenNoAuth\") client: ApiClient): TokenApi {\n        return client.buildClient(TokenApi::class.java)\n    }\n    \n    // ...\n }\n````\n\n3. Generate the code for the interceptor. Maybe its required to add the feign dependency for this explicitly in your build.gradle or pom file\n````kotlin\n@Component\nclass NordigenApiKeyInterceptor(\n    private val nordigenTokenProvider: NordigenTokenProvider\n) : RequestInterceptor {\n\n    override fun apply(template: RequestTemplate) {\n        val token = nordigenTokenProvider.getToken()\n        template.header(\"Authorization\", mutableListOf(\"Bearer $token\"))\n    }\n}\n\n@Component\nclass NordigenTokenProvider(\n    private val nordigenTokenApi: TokenApi,\n\n    @Value(\"\\${nordigen.id}\")\n    private val nordigenSecretId: String,\n    @Value(\"\\${nordigen.key}\")\n    private val nordigenSecretKey: String,\n) {\n    fun getToken(): String {\n        val body = JWTObtainPair().apply {\n            secretId = nordigenSecretId\n            secretKey = nordigenSecretKey\n        }\n        return nordigenTokenApi.jWTObtain(body).access\n    }\n}\n\n````\n4. Profit?! Now you can access the api\n````kotlin\n\n@Component\nclass ApiExample(private val agreementsApi: AgreementsApi) {\n\n    fun endUserAgreementRequest(institutionId: String): EndUserAgreement {\n        val endUserAgreementBody = getAgreementsBody(institutionId)\n        return agreementsApi.createEUAV2(endUserAgreementBody)\n    }\n    \n    private fun getAgreementsBody(institutionIdentifier: String): EndUserAgreement {\n        return EndUserAgreement().apply {\n            institutionId = institutionIdentifier\n            accessScope = listOf(\"balances\", \"details\", \"transactions\")\n            accessValidForDays = 10\n            maxHistoricalDays = 20\n        }\n    }\n}\n\n````\n\nFor more code see the informations in the generated [README](https://github.com/simonhauck/unofficial-nordigen-api-java/blob/master/generated/README.md)\n\n## Generated code\n\nThe code for this project is generated with the [OpenApi Generator](https://github.com/OpenAPITools/openapi-generator).\nThe generated code is in the ``generated`` directory.\n\n## Api Documentation\n\nPlease refer to\nthis [README](https://github.com/simonhauck/unofficial-nordigen-api-java/blob/master/generated/README.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonhauck%2Funofficial-nordigen-api-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimonhauck%2Funofficial-nordigen-api-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonhauck%2Funofficial-nordigen-api-java/lists"}