This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Deploying APIs for UK
This document guides you with the assumption that you have set up WSO2 Open Banking Key Manager and WSO2 Open Banking API Manager on separate servers.
Before you begin
- Create a user with Internal/creator and Internal/publisher roles using
https://<WS02_OB_KM_HOST>:9446/carbon
. To create users and roles, see configuring users and roles, which elaborates the steps to create the user as the API publisher. - Set endpoints in the velocity_template.xml file.
- Configure sequence files.
Configuring the velocity_template.xml
Make sure to update the <WS02_OB_KM_HOST>
in the consent enforcement handler
, as given below in the <WSO2_OB_APIM_HOME>/repository/resources/api_templates/velocity_template.xml
file, before creating the APIs.
<handler class="com.wso2.finance.open.banking.uk.consent.enforcement.ConsentEnforcementHandler"> #if($!apiVersion == "v3.0" || $!apiVersion == "v3.1") <property name="accountValidationUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk300/accounts-validation"/> <property name="paymentConsumtionUpdateUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk300/payments/{PaymentType}/{ConsentId}/status/{Status}"/> <property name="paymentSubmissionValidationUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk300/payment-submission-validation"/> <property name="paymentConsentDataUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk300/payments/{PaymentType}/{ConsentId}/Consumption"/> <property name="fundConfirmationValidationUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk300/funds-confirmation-validation"/> #elseif($!apiVersion == "v2.0") <property name="accountValidationUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk200/accounts-validation"/> <property name="paymentSubmissionValidationUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk110/payment-submission-validation"/> #else <property name="accountValidationUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk110/accounts-validation"/> <property name="paymentSubmissionValidationUrl" value="https://<WS02_OB_KM_HOST>:9446/consent/uk110/payment-submission-validation"/> #end <property name="keyStore" value="./repository/resources/security/wso2carbon.jks"/> <property name="password" value="wso2carbon"/> <property name="alias" value="wso2carbon"/> </handler>
Configuring the sequence files
Sequence files for Accounts, Payment, and CoF must be updated separately in the <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/ <Name of the API>
. Change the <WSO2_OB_KM_HOST>
and <WSO2_OB_APIM_HOST>
hostnames to the accurate hostnames as mentioned follows:
By default, WSO2 Open Banking API Manager includes a mock bank backend, which is configured by default in the In
sequences. Ideally, the two occurrences of https://<WSO2_OB_APIM_HOST>:9443/open-banking/services/accounts/accountservice
should be replaced by the core banking system's API endpoints corresponding to the production, and sandbox environments respectively. For more information, see Integrating Core Banking System.
Configuring TokenAPI.xml and AuthorizeAPI.xml
Make sure that the following handlers are in TokenAPI.xml
and AuthorizeAPI.xml
files in <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/api
.
<handlers> <handler class="com.wso2.finance.open.banking.common.identity.validation.SignatureAlgorithmValidatorHandler"/> </handlers>
Displaying the error response for access token failures in the UK error format
This is available only as a WUM update and is effective from September 23, 2019 (09-23-2019). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.
<WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/sequences/auth_failure_handler.xml
under the <sequence key="_cors_request_handler_"/>
configuration to display the error response for access token failures in the UK error format.<filter source="get-property('REST_API_CONTEXT')" regex=".*\/(pisp|aisp|cbpii).*"> <then> <class name="com.wso2.finance.open.banking.gateway.uk.AuthFailureResponseCreationMediator"/> <respond/> </then> </filter>
Create and publish an API
In the WSO2 Open Banking UK v3.1, it is mandatory to configure APIs for:
- Accounts API v3.1
- Payments API v3.1
- Confirmation of Funds (CoF) API v3.1
For instructions on deploying Dynamic Client Registration API v3.2, see Deploying Dynamic Client Registration API v3.2.
Follow the steps given below to create and publish an API.
- Create a user with Internal/creator and Internal/publisher roles in order to configure the API. For more information on creating a user, refer Configuring users and roles.
- If an API is already deployed with a previous version, you may create a new version of it instead of deploying a new API. For more information, see Create a new version for an existing API.
You can configure APIs through the API Publisher by signing in as a user whose role includes Internal/publisher
. Follow the steps given below:
Sign in to the API Publisher (
https://
<WSO2_OB_APIM_HOST>
:9443/publisherClick ADD NEW API > I have an existing API.
Select the Swagger definition from
<WSO2_OB_APIM_HOME>/repository/resources/finance/apis
and configure the properties according to the open-banking specification. Find more information from the table given below.
Click Start Creating.- Click Next: Implement to navigate to the next level.
- Expand Managed API, and use the table below to select the relevant Endpoint Type from the drop-down list.
- Check Select a message mediation policy to be executed in the message flow under Message Mediation Policies.
Click Upload In Flow and select the corresponding In sequence file from
<WSO2_OB_APIM_HOME>/repository/resources/finance/apis.
Click Next: Manage to navigate to the next level.
- Expand Throttling Settings. Under Subscription Tiers, check the option as Unlimited : Allows unlimited requests unless you want to limit the requests.
Expand API Properties and add the following values as Additional properties. Click the + button to save the values.
Property Name
ob-spec Property Value
uk Configure the open banking specification and the API type for the DCR API you deploy as follows:
This is available only as a WUM update and is effective from June 07, 2020 (06-07-2019). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.
- Click Save & Publish.
Summarized information for configuring APIs - UK specification
API | Implement tab | Manage tab | ||||
---|---|---|---|---|---|---|
Endpoint type | Endpoint | Enable Message mediation | In flow | API property name | API property value | |
AccountInfo API v3.1.1 | Dynamic | N/A | Mark as checked |
| ob-spec | uk |
ob-api-type | account | |||||
ob-api-version | 3.1.1 | |||||
Payments API v3.1.1 | Dynamic | N/A | Mark as checked
| <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Payments/3.1.1/payments-dynamic-endpoint-insequence-3.1.1.xml
| ob-spec | uk |
ob-api-type | payment | |||||
ob-api-version | 3.1.1 | |||||
Funds Confirmation API v3.1.0 | Dynamic | N/A | Mark as checked |
|
ob-spec
| uk |
ob-api-type | cof | |||||
ob-api-version | 3.1.0 | |||||
Event Notifications API v3.1.0 | Dynamic | N/A | Mark as checked | <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.0/notifications-dynamic-endpoint-insequence-3.1.0.xml
| ob-spec | uk |
ob-api-type | event | |||||
ob-api-version | 3.1.0 | |||||
Dynamic ClientRegistration API v3.2 | Dynamic | N/A | Mark as checked | <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/DynamicClientRegistration/3.2/dcr-dynamic-endpoint-insequence-3.2.xml
| ob-spec | uk |
ob-api-type | dcr | |||||
ob-api-version | 3.2 |
This is available only as a WUM update and is effective from March 26, 2019 (03-26-2019). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.
Create a new version for an existing API
In the API Publisher of WSO2 Open Banking, users are not allowed to duplicate the scope of an API. Therefore, users are allowed to create a new version for the API in order to share the same scope. See below to find how it is done:
- In the API Publisher (
https://<WSO2_OB_APIM_HOST>:9443/publisher
), click the API thumbnail to view the API overview. Select the CREATE NEW VERSION tab.
Follow the versioning format and define the new version.
Click Done.
Users need to define the correct version for the API and choose the swagger and In sequence files appropriately.
The directory path to the files in the solution pack helps you to choose the correct file. For example, choose the swagger and in sequence files from
<WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Payments/3.1.1
if you want to create the 3.1.1 version of Payment Initiation API.- Click on the newly created API and click EDIT API.
- You are redirected to the Design phase. Click the Edit Source button under API Definition section.
- In the Swagger Editor menu bar, select File>Import File.
- Browse for the intended swagger file in
.yaml
format and click Open File. - Click Apply Changes to save the changes and go back to the Design page.
- Scroll down and click Save.
- Click Next: Implement > to navigate to the next page.
- Expand Managed API, and click Upload In Flow.
- Select the relevant
In sequence
file for the corresponding API and its version, and click Upload. - Click Next: Manage > to navigate to the next page.
- Expand API Properties and ensure the
ob-spec
property is set to reflect the correct specification. Click Save & Publish.
To get the existing subscriptions to the new version, follow the steps below:
- In the API Publisher, click the new API thumbnail to Browse API.
- Go to the Lifecycle tab.
Tick the relevant boxes if you want to:- Deprecate the old versions after publishing this new version.
- Remove the existing subscriptions and require the applications to re-subscribe.
- Click Publish.
- To verify the subscriptions, go to the Versions tab.
- In the API Publisher, click the new API thumbnail to Browse API.