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 Consumer Data Standards Administration API v1.2.0

Owned by Former user (Deleted)
Last updated: Sept 26, 2023 by Akram Azarm
9 min read

Before you begin:

Configure Metadata Cache Management endpoint that is required for the Administration API.

  • Open the  <WSO2_OB_APIM_HOME>/repository/conf/deployment.toml  file.

  • Add the following configurations and restart the server. 

[open_banking.au.metadata_cache]
metadata_mgt_endpoint = "https://<WSO2_OB_IAM_HOST>:9446/api/openbanking/au-metadata-mgt/au100/register/metadata"

The following configuration is to generate self-link in the CDS Administration API response. This is only available as a WSO2 Update from WSO2 Open Banking API Manager Level 2.0.0.46 onwards. For more information on updating WSO2 Open Banking, see Updating WSO2 Products.

[open_banking.au.admin.api]
self_url = "_self-url_"

  • Add the following synapse configurations to retrieve infosec statistics:

    This is available only as a WSO2 Update and is effective from July 09, 2021 (07-09-2021). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.

     Click here to see how it done...
    1. Go to the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/api/ directory.
    2. Open the following files and update them by adding the given property and handlers:
      1. _TokenAPI_.xml
      2. _RevokeAPI_.xml
      3. _AuthorizeAPI_.xml

    3. Add the following property just under the <inSequence> tag: 

      <property name="api.ut.backendRequestTime" expression="get-property('SYSTEM_TIME')"/>

    4. Add the following two handlers just under the <handlers> tag: 

      <handler class="org.wso2.carbon.apimgt.gateway.handlers.common.APIMgtLatencyStatsHandler"/>
<handler class="com.wso2.finance.open.banking.management.information.reporting.data.publisher.ReportingDataHandler"/>

  • If you want to support ID permanence, make sure to follow the below steps before deploying the CDS Standard API  in <WSO2_APIM)_HOME>/repository/resources/finance/apis/consumerdatastandards.org.au/<version>:

    This is available only as a WUM update and is effective from March 24, 2021 (03-24-2021). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.

     Click here to see how it done...

    1. Open <WSO2_OB_APIM_HOME>/repository/resources/api_templates/velocity_template.xml 

    2. Under #if($apiObj.additionalProperties.get("ob-spec") == "au" && $apiObj.additionalProperties.get("ob-api-type") != "dcr" && $apiObj.additionalProperties.get("ob-api-type") != "cdr-arrangement" && $apiObj.additionalProperties.get("ob-api-type") != "cds-admin"), add <handler class="com.wso2.finance.open.banking.gateway.au.IdPermanenceHandler"/>
      after <handler class="com.wso2.finance.open.banking.gateway.api.schema.validation.RequestSchemaValidationHandler"/> and before <handler class="com.wso2.finance.open.banking.au.consent.enforcement.AUConsentEnforcementHandler">:

       Click here to see modified the configuration...
      ##
## Start of AU Specification Handlers
##

#if($apiObj.additionalProperties.get("ob-spec") == "au" && $apiObj.additionalProperties.get("ob-api-type") != "dcr"
&& $apiObj.additionalProperties.get("ob-api-type") != "cdr-arrangement"
&& $apiObj.additionalProperties.get("ob-api-type") != "cds-admin")
<handler class="com.wso2.finance.open.banking.custom.throttling.CDSThrottlingPolicyHandler"/>
<handler class="com.wso2.finance.open.banking.mtls.validator.handler.MTLSValidationHandler"/>
<handler class="com.wso2.finance.open.banking.gateway.common.APIResourceAccessHandler"/>
<handler class="com.wso2.finance.open.banking.mtls.validator.handler.HolderOfKeyValidationHandler"/>
<handler class="com.wso2.finance.open.banking.gateway.api.schema.validation.RequestSchemaValidationHandler"/>
<handler class="com.wso2.finance.open.banking.gateway.au.IdPermanenceHandler"/>
<handler class="com.wso2.finance.open.banking.au.consent.enforcement.AUConsentEnforcementHandler">
    <property name="validationBaseUrl" value="https://IAM_HOSTNAME:9446/api/openbanking/consent-mgt/au100"/>
</handler>
#end

      In case you have already deployed and subscribed the CDS Standard API, 

      • Open the <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/api/<API_PUBLISHER_NAME>–ConsumerDataStandards_vv1.xml. For example, <WSO2_OB_APIM_HOME>/repository/deployment/server/synapse-configs/default/api/mark-AT-gold.com--ConsumerDataStandards_vv1.xml and locate the <handlers> tag

      • Add <handler class="com.wso2.finance.open.banking.gateway.au.IdPermanenceHandler"/>
        after <handler class="com.wso2.finance.open.banking.gateway.api.schema.validation.RequestSchemaValidationHandler"/> and before <handler class="com.wso2.finance.open.banking.au.consent.enforcement.AUConsentEnforcementHandler">:

        <handler class="com.wso2.finance.open.banking.gateway.api.schema.validation.RequestSchemaValidationHandler"/>
<handler class="com.wso2.finance.open.banking.gateway.au.IdPermanenceHandler"/> 
<handler class="com.wso2.finance.open.banking.au.consent.enforcement.AUConsentEnforcementHandler">

    1. Configure the encryption/decryption key for ID permanence. By default, the secret value is "wso2". 

      [open_banking.au.id_permanence]
secret_key = <SECRET_KEY>
    2. Restart the servers.

  1. Sign in to the API Publisher Portal (https://<WSO2_OB_APIM_HOST>:9443/publisher) as an API creator/publisher.

  2. In the APIs tab, select CREATE NEW API > I Have an Existing REST API. 

  3. Set the Input Type to OpenAPI File. 

  4. Click BROWSE FILE TO UPLOAD and select the <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/consumerdatastandards.org.au/CDSAdminAPIs/1.2.0/cds-admin-1.2.0.yaml Swagger file.

  5. Click Next. 

  6. Set the endpoint as follows: 

    https://<WSO2_OB_APIM_HOST>:9443/api/openbanking/cds-admin-api/au100
  7. Set the business plan to Unlimited : Allows unlimited  requests unless you want to limit the requests. 

  8. Click Create to create the API.
  9. Once you get the message that the API is successfully updated, go to Runtime Configurations using the left menu panel.

  10. Click the edit button under Request > Message Mediation. 

  11. Now, select the Custom Policy option.   
  12. Upload the <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/consumerdatastandards.org.au/CDSAdminAPIs/1.2.0/cds-admin-endpoint-insequence-1.2.0.xml file and click SELECT. 

  13. Scroll down and click SAVE.
  14. Now, go to  Properties using the left menu panel.

  15. Click Add New Property.

  16. Add the following properties and click  the Add button to save the values.

    Property NameProperty Value
    ob-specau
    ob-api-typecds-admin

  17. Click SAVE.

  18. Go back to Overview using the left menu panel.

  19. Click PUBLISH.

  20. The published API is available in the Developer Portal at https://<WSO2_OB_APIM_HOST>:9443/devportal.

Invoke Metrics API

GET Metrics - GET /admin/metrics

GET /admin/metrics is an endpoint determined by the non-functional requirements for the CDR regime to obtain statistics. 

  • This operation may only be called by the CDR Register.
  • The CDR regime will authenticate the clients seeking access to end points based on a signed JWT.

This is the only endpoint available in the API. A sample request and response are as follows:

Availability Metrics

This is the endpoint that determines the percentage availability of the CDR platform over time. Availibility is calculated as follows: 

Data Holders have to publish the outage data to Open Banking Business Intelligence in the following format:

Note:

  • Outages between months need to publish as separate events.
  • Availability value is rounded up to 2 decimal points.
  • Availability metrics calculate for previous months based on the oldest published data (up to a maximum of 12 months).

Publishing Outage Information

Availability Metrics v3

This is available only as a WUM update and is effective from April 09, 2021 (04-09-2021). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.

Deleting Outage Information

This is available only as a WSO2 Update and is effective from September 17, 2021 (09-17-2021). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.

You can delete outage information using the /AvailabilityMetricsRawDataApp/IncidentDeletionRawDataStream endpoint.