Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleContents

Table of Contents

API Products

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

...

Note

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.

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.

    Info

    An acknowledgment message appearing on the top of the page.

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

Fetching Consumer Key and Customer 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.

...

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

Note

An error message gets displayed for invalid input.


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.

...

Adaptavist ThemeBuilder EngineAtlassian Confluence