The Apigee Open Banking APIx solution simplifies and accelerates the process of delivering open banking by providing secure, ready-to-use APIs along with the computing infrastructure to support internal and external innovation.
This document is organized into the following sections
1.Overview
2.Design
3.Setup
5.Data
The OpenBank solution is built on Apigee Edge API Management Platform, and features the following APIs:
Account Access APIs
- Account Request
- Account Information
- Transactions
- Balances
- Direct Debits
- Standing Orders
- Products
Payment Initiation APIs
- Single Immediate Payment
- Payment Submission
Open Data APIs
- ATMs
- Branches
- Bank Products
Security APIs
- OAuth
- UserInfo
The Account Access APIs follow the Open Banking Account and Transaction API Specification - v1.0.0 and Payment Initiation APIs follow Payment Initiation API Specification - v1.0.0
It also provides an implementation of Open Banking Security Profile v1.0.0. It is OpenID and oAuth based authentication, having consent and two-factor authentication using phone number and PIN based authentication using external SMS API.
This repository contains the necessary artifacts that will allow one to pull up a complete set of Banking APIs that comply with CMA 1.0 specification (that in turn comply with Openbanking and PSD2 ) regulations. In addition this will also allow one to build a sandbox complete with a Developer Portal, dummy backend and a sample app.
The APIs provided are configurable to connect to your Core Banking systems and for the use of developer applications, and to obtain end user consent. The following sections will help you understand this solution so that you can go about this on your own.
The Banking APIs are designed such that each API is chained together as Northbound <-> Southbound APIs.
As shown in the architecture diagram above, the message flow is as follows: End user Application <-> Northbound APIs <-> Southbound APIs <-> Backend Systems (Core Banking / Payment etc)
The Northbound API provides a fixed set of interfaces, complying with respective Open Banking specification, that can be used by the external consumers. In order to minimize changes to the contract, and there by to applications that connect to it, this API may not be required to change as often.
The Southbound API connects to the actual backend of the bank. We have used a Sandbox backend as a default as part of this solution build out. Therefore you may want to modify the southbound interfaces to suite your specific backend needs.
All Southbound APIs end with the suffix '-connector'
In addition, there are some internal APIs which are not exposed outside, but which are used internally from the other APIs and provide common services like sending out SMS.
Each API deployed in Apigee Edge is encapsulated withing a unit of deployment called a Proxy. To Learn more on the basic concepts of how to manage these within Apigee Edge, please refer to : http://docs.apigee.com/api-services/content/what-apigee-edge
Each of the following entities in the sequence diagram below, such as oAuth, consent-app , session,authentication-connector are examples of proxies.
There are two broad sets of proxy definitions in the solution. One set, Security, helps manage the security around the APIs while the other is the set of Functional APIs that a bank would like to expose. For example: accounts, payments, etc.
In this solution, access to all APIs are protected via a security mechanism, that requires explicit end user authentication and authorization to make a successful API call. We have broadly used the OAuth 2.0 framework to secure these APIs, with integrated consent management application to manage end user authorization. Therefore, one has to obtain a valid Access Token or a one time Token via the Security APIs before making a call to the Functional APIs. In order to enable two-factor authentication for the functional APIs, OTP(one time password) mechanism via SMS has been enabled for each of the APIs, which can be disabled on demand. The sequence diagram below gives an overview on the call flow between various security related proxies to fetch a valid Access Token with two-factor authentication enabled.
The Login app provides a basic user authentication functionality. It uses User Management API to verify the user credentials. The User Management APIs connect to a Sandbox user store. The banks might want to replace the Login App with their corporate login page
The consent app uses login app for the user securely authenticate with the bank. The consent app is a trusted app of the bank which will allow the user to login and subsequently provide consent information.
The consent app will talk to the following APIs in order to fulfill its functionality : Consent API, SMS API, Accounts-connector API, Payment-connector API, Authentication-connector API and Customer Management API. For more details on each of these APIs, refer to the README.md of the respective proxy which exposes these APIs.
The Functional APIs deployed and available as part of OpenBank solution are broadly classified as follow:
Account Information APIs provide account information for accounts held by the consumer. Information is categorized into:
- Request (for Account Information)
- Information
- Balance
- Transactions
- Direct debits
- Standing Orders
- Products
An API end point is provided for each type of information. These Account Information APIs are secured with oAuth 2.0 and need a valid Access token for making API calls.
Payment Initiation APIs provide a simple one time payment functionality. It has two sets of APIs:
- Payment request - (CREATE, GET and DELETE) to request for a one time payment
- Payment submission - (CREATE, GET) to submit payment request for actual payment.
The Payment Initiation APIs are also secured with oAuth 2.0 and need a valid Access token.
Open Data APIs provide API access for public data, like information about Bank Branches. These APIs do not need any authentication. The APIs available are:
- ATMs - To search on the available list of ATMs, based on the location.
- Branch - To search on the Bank's Branch listing based on the location or open time or services available
- Products - The list of banking products that availed with the Bank.
Banking APIs provide developers with the information needed to create innovative Fintech apps for consumers.There are a few obvious use cases worth mentioning:
- Aggregation of financial metrics such as net worth and savings across multiple accounts.
- Analysis and recommendations for better money management.
- Recommendation of products and deals based on monthly statements.
The OpenBank deployment architecture is as shown above.
- Create an Apigee API Management Developer Account
- Request For Apigee Developer Portal, if you want to use portal
The OpenBank Solution is using Google Cloud Datastore as backend. To setup the OpenBank solution , there are two options available:
- Using one's own Google Cloud Datastore instance
- If you do not have Goole Cloud Platform access then OpenBank solution can still be deployed and run with public south-bound endpoint for Datastore hosted by Apigee
To shift from Apigee's public south-bound endpoint to own Datastore instance, follow the steps here
Note: you can also setup OpenBank solution on Apigee BaaS following the steps here
If one wants to setup the OpenBank solution on own Google Cloud Datastore instance, create a Google Cloud project, enable Datatsore and create a service account and download the service account as .json .
To Learn more on the basic concepts of Apigee Edge, please refer to : http://docs.apigee.com/api-services/content/what-apigee-edge
To Learn more on Google Cloud Datastore, please refer to : https://cloud.google.com/datastore/docs/concepts/overview
To deploy the APIs and its dependencies on your own org please run the following script from the root folder of the cloned repo.
- node.js
- npm
- Two pair of RSA256 keys, one for the Bank and other for the Tpp
#to generate bank's keys
ssh-keygen -t rsa -b 4096 -f bank.key
# Don't add passphrase
openssl rsa -in bank.key -pubout -outform PEM -out bank.key.pub
#to generate tpp's keys
ssh-keygen -t rsa -b 4096 -f tpp.key
# Don't add passphrase
openssl rsa -in tpp.key -pubout -outform PEM -out tpp.key.pub
Install gulp
npm install --global gulp-cli
Pull node modules
npm install
Run the deploy command
gulp openbankdeploy --env <env>
This will ask you if you have your own Datastore instance, or want to use the Apigee's public south-bound endpoint for Goole Cloud Datastore. If you choose to use your own Datastore instance, the script will additionally prompt you for
- Google Cloud Project Id
- Service account private key for Datastore
- Token uri associated of the service account
- Client email of the service account
Once above inputs are provided, the script will interactively prompt you for following details, and will then create / deploy all relevants bundles and artifacts and will provision the OpenBank Sandbox on your own Org.
- Edge Org name
- Edge Username
- Edge Password
- Consent Session Key for signing the Session Cookie
- Login App Key for signing the user details
- Bank private key file path (please enter full path)
- Bank public key file path (please enter full path)
- TPP private key file path (please enter full path)
- TPP public key file path (please enter full path)
Once the deploy script is complete, run the following command to do a basic sanity test that the APIs are working
run tests
gulp test
There are 2 options available for migrating from Apigee's public south-bound endpoint for Datastore to own Datastore Instance:
- Re-deploy the solution using the above script with Datastore credentials(This option will redeploy the proxies and all new changes made to the northbound proxies will go away).
- Manually make changes required:
- Manually make changes to all the northbound proxies
- src/gateway/login-app/target/apiproxy/resources/node/config.json
- src/gateway/locations/target/apiproxy/targets/default.xml
- src/gateway/products/target/apiproxy/targets/default.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Create-ID-token.xml
- src/gateway/consent-app/target/apiproxy/resources/node/config.json
- src/gateway/accounts/target/apiproxy/policies/Fetch-Account-Consent.xml
- src/gateway/accounts/target/apiproxy/policies/Get-Acc-Req-Data.xml
- src/gateway/accounts/target/apiproxy/policies/Update-Access-Count.xml
- src/gateway/accounts/target/apiproxy/targets/default.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Update-Account-Request.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Update-Payment-Request.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Validate-Account-Request.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Validate-Payment-Request.xml
- src/gateway/oauth/target/apiproxy/targets/default.xml
- src/gateway/payments/target/apiproxy/policies/Service-Callout-Validate-Payment-Request-Status.xml
- src/gateway/payments/target/apiproxy/policies/Service-Callout-Fetch-and-Validate-Consent.xml
- src/gateway/payments/target/apiproxy/targets/default.xml
- Update the service account key value for 'privateKey' key in the KVM GoogleServiceAccountKVM
- Replace the variable {{ datastoreProject }} with your Google Cloud project-Id in:
- src/gateway/datastore-connector/target/apiproxy/targets/default.xml
- src/gateway/datastore-connector/target/apiproxy/policies/Service-Callout-Get-Entity.xml
- Replace the variable {{ client_email }} with your project service account client email in:
- src/gateway/datastore-connector/target/apiproxy/policies/Generate-JWT-Datastore.xml
- Replace the variable {{ token_uri }} with your Google Cloud project service account token uri in:
- src/gateway/datastore-connector/target/apiproxy/policies/Generate-JWT-Datastore.xml
- src/gateway/datastore-connector/target/apiproxy/policies/Service-Callout-Get-Access-Token.xml
- Manually make changes to all the northbound proxies
If you want to setup the OpenBank solution on BaaS, southbound proxies are available in path /src/gateway with 'baas' suffix. You can setup OpenBank on BaaS by following the steps bellow:
-
Create an Apigee BaaS account
-
Create BaaS collections corresponding to the .json file name in /setup/data and upload the data to the collections from respective .json files
-
Additionally create empty collections :
- payments
- payment-submissions
- id-tokens
-
Replace the variable {{ baasBasePath }} with value of {baasBasePath}/{baasOrg}/{bassApp} in the BaaS southbound proxies in path /src/gateway:
- /src/gateway/accounts-connector-baas/apiproxy/policies/Assign-Target-URL.xml
- /src/gateway/consent-management-baas/apiproxy/resources/node/package.json
- /src/gateway/customer-management-baas/apiproxy/targets/default.xml
- /src/gateway/locations-connector-baas/apiproxy/policies/Assign-Target-URL.xml
- /src/gateway/products-connector-baas/apiproxy/policies/Assign-Target-URL.xml
- /src/gateway/user-management-baas/apiproxy/targets/default.xml
- /src/gateway/payments-connector-baas/apiproxy/resources/node/package.json
-
Replace the variable {{ baasClientId }} with clientId for the BaaS Org in the BaaS southbound proxies:
- /src/gateway/accounts-connector-baas/apiproxy/resources/node/package.json
- /src/gateway/consent-management-baas/apiproxy/resources/node/package.json
- /src/gateway/customer-management-baas/apiproxy/policies/Assign-clientIdSecret.xml
- /src/gateway/locations-connector-baas/apiproxy/resources/node/package.json
- /src/gateway/payments-connector-baas/apiproxy/resources/node/package.json
- /src/gateway/products-connector-baas/apiproxy/resources/node/package.json
-
Replace the variable {{ baasClientSecret }} with clientId for the BaaS Org in the BaaS southbound proxies:
- /src/gateway/accounts-connector-baas/apiproxy/resources/node/package.json
- /src/gateway/consent-management-baas/apiproxy/resources/node/package.json
- /src/gateway/customer-management-baas/apiproxy/policies/Assign-clientIdSecret.xml
- /src/gateway/locations-connector-baas/apiproxy/resources/node/package.json
- /src/gateway/payments-connector-baas/apiproxy/resources/node/package.json
- /src/gateway/products-connector-baas/apiproxy/resources/node/package.json
-
Upload the proxy bundles to your Edge Org
-
Make changes to northbound proxies to change the Target Endpoints and ServiceCallout Endpoints to the BaaS southbound proxies:
- src/gateway/login-app/target/apiproxy/resources/node/config.json
- src/gateway/locations/target/apiproxy/targets/default.xml
- src/gateway/products/target/apiproxy/targets/default.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Create-ID-token.xml
- src/gateway/consent-app/target/apiproxy/resources/node/config.json
- src/gateway/accounts/target/apiproxy/policies/Fetch-Account-Consent.xml
- src/gateway/accounts/target/apiproxy/policies/Get-Acc-Req-Data.xml
- src/gateway/accounts/target/apiproxy/policies/Update-Access-Count.xml
- src/gateway/accounts/target/apiproxy/targets/default.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Update-Account-Request.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Update-Payment-Request.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Validate-Account-Request.xml
- src/gateway/oauth/target/apiproxy/policies/Service-Callout-Validate-Payment-Request.xml
- src/gateway/oauth/target/apiproxy/targets/default.xml
- src/gateway/payments/target/apiproxy/policies/Service-Callout-Validate-Payment-Request-Status.xml
- src/gateway/payments/target/apiproxy/policies/Service-Callout-Fetch-and-Validate-Consent.xml
- src/gateway/payments/target/apiproxy/targets/default.xml
Every API provider must be able to educate developers and successfully expose their APIs. A developer portal is the face of your API program, providing everything that internal, partner, and third party developers need.
Developers need to interact with the Banks and with each other. Enable your developer community to provide feedback, make support and feature requests, and submit their own content that can be accessed by other developers with the right developer portal.
Apigee Edge provides with a Developer Services portal that you can use to build and launch your own customized website to provide all of these services to your development community. One has the option to create their own developer portal, either in the cloud or on-premises.
The below picture depicts how a dev portal looks like
The detailed instructions for developer portal setup for openbank solution can be found Here.
The dummy Backend system is created by the deploy script for this OpenBank solution and is hosted on Google Cloud Datastore in your org. You can find the dummy data under ./setup/data folder
Additional notes for implementors.
- The APIs use Public/Private Key pair for doing JWS signing of the Payload.
- Private key for the bank has to be provided during deployment. It is recommended to define a Prompt in config.yml and use it as value for the private key.
- For Production access, a Mutual TSL connectivity needs to be configured as defined here.
- While running
gulp openbankdeploy --env <env>please do make sure there are no custom APIs defined with the same names; otherwise those APIs will be overwritten with a new revision.
- APIs / API Spec
- OpenBank shifted from BaaS 2.0 . Hosted on Google Cloud Datastore
- APIs / API Spec
- Payment Initiation APIs added
- APIs / API Spec
- Account APIs are made compliant with OpenBanking v1.0.0
- Support for Open Bank Security Profile v1.0.0 - hybrid flow
- APIs / API Spec
- APIs are made compliant with CMA 0.1 spec
- Support for CMA 0.1 consent model for Accounts and Payments APIs
-
APIs / API Spec
- Refined Products API and added to Developer Portal Smartdocs
- Updated OpenAPI spec for Products API
-
Installation
- New node-based deployment script
- New script for easier portal setup
-
Documentation
- New video overview of the OpenBank APIs and Installation - http://www.youtube.com/watch?v=8eecvL75B5w
- Updated API documenation
- Updated installation instructions for APIs and Developer Portal
- Added Products API
- Changed URL of OpenData APIs (/atms and /branches)
- /apis/v1/opendata/locations/atms -> /apis/v1/locations/atms
- /apis/v1/opendata/locations/branches -> /apis/v1/locations/branches