API Products page

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

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.

After the SSA gets generated, it can be used to register the TPP and get the client credentials as shown in the screenshots 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.
   

   Properties	Description
   Id	Provide a unique ID that refers to the function or purpose of the application.
   Organization Id issued by OBUK	Organization ID provided by the provider.
   Name	Preferred name of the application.
   Description	A brief description explaining the purpose and features of the application.
   SSA Issued by OB UK	SSA issued by the provider.
   Redirect URI	Provide the URI to redirect to a particular page after authorization.

   

   
   

3. The app gets registered with the ID provided.

   An acknowledgment message appearing on the top of the page.

   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.

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.

Authorization

Detailed documentation of the API with complete information about the parameters involved, sample requests and responses, and authentication mechanisms used can be viewed in the API Documentation section. Click an Environment name (see the figure above) for API Documentation.

If the REST APIs are protected, click the Authorize button to unlock the APIs.

Provide the Client ID which is the Consumer Key mentioned in the Registering to the PSD2 APIs section of the respective product and click Authorize.

Testing the APIs

Expand a tag to see the APIs available under it.

Expand the API to see the parameters under it and click the Try it out button to test the API.

Forums

Forum section helps to start a discussion or take part in a discussion. For any questions or suggestions to the administrator, post them in the Forums section as a new Topic.

To post content in the forum,

1. Click the Forum name (see the figure above) and click the New topic button to create a topic.
   
   
   
   
2. Provide the following and click Save.

   1. topic heading in the Subject text box.

   2. content in the Body text area.

      Before publishing the content, the Preview button helps to have a preview of the content as it appears on the forum.