Deploy NextGenPsd2XS2AFramework API

This page provides instructions to deploy the NextGenPsd2XS2AFramework API. NextGenPSD2 Reference Toolkit provides the Account Information Service (AIS), Payment Initiation Service (PIS), and Confirmation on the Availability of Funds Service (FCS) via the NextGenPsd2XS2AFramework API.

  1. Sign in to the API Publisher Portal at https://<APIM_HOST>:9443/publisher with the creator/publisher privileges.

    sign_in

  2. In the homepage, go to REST API and select Import Open API. let's_get_started

  3. Select OpenAPI File/Archive. create-an-api

  4. Click Browse File to Upload and select the <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/repository/resources/apis/berlin.group.org/PSD2API_1.3.6/psd2-api_1.3.6_20200327.yaml file.

  5. Click Next.

  6. Set the context to /xs2a.

  7. Remove the existing endpoint configuration and leave the field empty. set-context

  8. Click Create to create the API. create-accounts

  9. After the API is successfully created, go to Portal Configurations using the left menu panel. portal-configurations

  10. Select Subscriptions from the left menu pane and set the business plan to Unlimited: Allows unlimited requests. business-plan

  11. Click Save.

  12. Select Runtime from the left menu pane.

  13. Toggle the Schema Validation button to enable Schema Validation. schema-validation

  14. Go to Develop -> API Configurations -> Policies in the left menu pane to add a custom policy. select_policies

  15. On the Policy List card, click on Add New Policy.

  16. Fill in the Create New Policy.

  17. Upload the <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/repository/resources/apis/berlin.group.org/PSD2API_1.3.6/dynamic-endpoint-insequence-1.3.6.xml insequence file. uplaoad_insequence

  18. Scroll down and click Save. Upon successful creation of the policy, you receive an alert as shown below: successful

  19. Expand the API endpoint you want from the list of API endpoints. For example: expand_api_endpoint

  20. Expand the HTTP method from the API endpoint you selected. For example: expand_http_method

  21. Drag and drop the previously created policy to the Request Flow of the API endpoint. request_flow

  22. Select Apply to all resources and click Save.

  23. Scroll down and click Save.

  24. Use the left menu panel and go to API Configurations > Endpoints.

    select_endpoints

  25. Add a Dynamic Endpoint. add_dynamic_endpoint

  26. Go to Deployments using the left menu pane.

    select_deployments

  27. Select the API Gateway type, in this scenario, it is Default. api_gateway

  28. Click Deploy.

  29. Go to Overview using the left menu pane.

    select_overview 30. Click Publish. publish_api

Summarized information for configuring API

Given below is a summary of configurations to follow when deploying the API in the toolkit.

API Swagger definition (yaml file) Endpoint type Message mediation (sequence file)
NextGenPSD2XS2A API v1.3.6 <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/repository/resources/apis/berlin.group.org/PSD2API_1.3.6/psd2-api_1.3.6_20200327.yaml Dynamic Endpoint <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/repository/resources/apis/berlin.group.org/PSD2API_1.3.6/dynamic-endpoint-insequence-1.3.6.xml
Top