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 section below.
Registering an application
To register an app,
- Click the Applications tab and click the Register button.
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. The app gets registered with the ID provided.
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.