Contents

API Products page

The API Products screen displays the products available to be used in applications.

Icon

Subscription status will be "no" if products are not used by any application. To subscribe to a product, register an application.

API Catalog

Click the product name to see the API categories (groups under which various APIs are available) available in the selected product.

Dynamic Client Registration

After creating the account in the developer portal, TPP can register for the APIs and get the consumer key and consumer secret. In order to register for the APIs, the TPP has to provide an SSA (Software statement Assertion) and Organization ID.

SSAs are essentially JSON Web Tokens (JWT) issued and signed by Open Banking.

There are two ways to generate Software Statement Assertions:

  • SSA generation using DFI Portal: 
  • Dynamic SSA generation using the API.
Icon

Please refer to Openbanking specifications for a detailed description on how to get the SSA.

After the SSA gets generated, it can be used to register the TPP and get the client credentials as shown in the section below.

Registering an application

To register an app,

  1. Click the Applications tab and click the Register button.



  2. Select the products required for the app, provide the following details, and click Register.

    PropertiesDescription
    IdProvide a unique ID that refers to the function or purpose of the application.
    Organization Id issued by OBUKOrganization ID provided by the provider.
    NamePreferred name of the application.
    DescriptionA brief description explaining the purpose and features of the application.
    SSA Issued by OB UKSSA issued by the provider.
    Redirect URIProvide the URI to redirect to a particular page after authorization.


  3. The app gets registered with the ID provided.

    Icon

    An acknowledgment message appearing on the top of the page.

    Icon
    • Click Edit to make any changes to the application.
    • Click Unregister to unsubscribe the products.

Fetching Consumer Key and Secret

Click the Application Id name (see the figure above) to see the Consumer Key and Consumer Secret generated for the respective product.

Checking API Documentation

Click the API Products tab to go to the API Products page.

Icon

Notice that the Subscription status is changed to "yes" as the products are subscribed by the application.

Click the API Product name (see the figure above) to see the API Categories in the product; click the environment name of the respective API category to work with the APIs associated with the project.

Adaptavist ThemeBuilder EngineAtlassian Confluence