User guide

The API Portal provides organizations and their developers with all necessary information to start using offered services.
In this section you find the description of the sections on the main menu bar.

NOTE:Diversity of sections available differs for logged in and not logged in users. To see all the options available, please, log in.

HOME

Home page describes registration and authorization APIs used to protect access to the Open Banking API.

DASHBOARD

The Dashboard is the primary page for Developers, API Owners, Business Managers, and Account Managers. The navigation sidebar displays different links depending on the role of the logged in user. However, individual users can personalize the Dashboard. After you log in, the Dashboard page appears by default.

Here publishers can generate reports on APIs and organizations, access ranked reports, generate reports on their applications. Also, they can manage the personal and organization information, manage applications etc.

API EXPLORER

Use the API Explorer to test or change an API resource by sending a request. You can also view the queries sent that generated the response as well as code samples. Any published API with a WADL attached to it is automatically pre-populated into the API Explorer Using the API Explorer

The API Explorer lets Developers interactively discover your APIs. By making choices from among your API's valid resources and methods, and then submitting queries and viewing responses, Developers can gain a better understanding of not only how your APIs work, but also the authentication methods required to access them.

APIs & PLANS

All users of the API Developer Portal, even anonymous users, can browse the API catalog and the Plan catalog. The API catalog displays basic information about the APIs published on the API Portal. The Plan catalog displays basic information about API plans and Account plans. 

The catalogs are especially useful to Organization Administrators and Developers. They can browse the APIs and plans before they register. They can also use the API catalog to monitor changes to the status, version, and popularity of APIs. 

Section contains technical documentation, which provides users with the information about registration, including prerequisites details, general information on API, API key, sandbox. Also, users can find all the information about license, multiple company registrations, approval durability etc.