Support

Using our APIs

I just want to use an API? What are plans?

A plan is collection of API resources or subsets of resources from one or more APIs. A plan can contain a mixture of operation types from different APIs. A plan can have a common rate limit for all the resources or each resource can have a different rate limit. Rate limits specify how many requests an application is allowed to make during a specified time interval.

Use this Developer Portal to browse the different plans that are available to you and select a plan that is most suitable for your requirements. Some plans have restricted access that you must request access to use. When you submit your request, the organization is notified, the API administrator assesses your request and they might contact you for more details. Other plans are available to use straight away.

How do I see my API usage?

The numbers of requests, for different APIs, that your application has made are shown on your application page.

Click 'Apps' in the main menu and then click on your application. In the 'Product Subscriptions' table you will see all plans your application is subscribed to.

For each API contained in that plan you can see the usage compared to the rate limit of the plan.

How can I test an API?

It is possible to test an API from this Developer Portal.

When looking at the details of an API you will see a list of the operations contained in the API. This will show the verb and path to use for the operation.

If you click on the operation you will see more information about it, what parameters it might take, what it returns, what possible return codes it might use and what they mean.

There is also a 'Try' button on REST APIs which enables you to try the operation out direct from the Developer Portal.

If the API requires a client ID or a client secret for identification then you can specify these using your application credentials at the top of the 'Try' section.

Apps

How do I register an application?

When you add an application you are provided with an API Key and Secret for the application. You must supply these credentials when you call an API that requires you to authenticate your application.

To register an application click on Apps in the main menu and then click on the 'Create new app' link. Once you have provided an application name, description, etc you will be shown your application API Key and Secret.

Make a note of your API Secret because it is only displayed once.

How do I reset my application API Secret?

Your API Secret is stored encrypted so we cannot retrieve the unencrypted version to tell you the value if you forget it.

You can reset it, which will update the stored value and return the new value to you.

To do that click 'Apps' in the main menu, click on the application in question and then you can click the 'Reset' link in the 'API Secret' section.

Your new Secret will be displayed at the top of the page.

Developer Portal FAQs

What is a developer portal?

The developer portal is a platform that provides access to APIs, documentation, tools, and resources to developers who want to build applications that integrate with the open banking services.

How do I register as a developer on the developer portal?

To register as a developer the developer portal, you usually need to create an account and provide some basic information about yourself, such as your name, email address, and company name. You may also need to agree to the developer portal's terms of use.

What kind of APIs are available on the developer portal?

The APIs available on the developer portal may include APIs for account information, payments, transactions, authentication, and other open banking/BaaS services.

How do I obtain an API key to access the APIs on the developer portal?

To obtain an API key, you need to create an application on the developer portal and follow the instructions to generate an API key.

How do I test my integration with the APIs?

The developer portal provides a sandbox environment where you can test your integration with the listed APIs without affecting live user data.

What documentation and resources are available on the developer portal?

The developer portal provide documentation, sample code, and other resources to help developers use the APIs and build applications.

What kind of support is available for developers on the developer portal?

The developer portal provides support through documentation, forums, FAQs, and email support.

How do I report issues or provide feedback on the developer portal?

User are able to report issues or provide feedback through the developer portal's support channels via email, forums or the support ticketing system.

What are APIs?

APIs (Application Programming Interfaces) are sets of protocols, routines, and tools for building software applications. APIs specify how software components should interact and enable developers to access data or functionality from other applications or services

What is API documentation?

API documentation is a set of instructions and guidelines that explain how to use an API. It typically includes information on the API's endpoints, parameters, response formats, and authentication requirements.

What is API rate limiting?

API rate limiting is the practice of limiting the number of requests that can be made to an API within a certain time period. This helps prevent overloading the API and ensures that it remains available and responsive to all users.

What is API analytics?

API analytics is the process of collecting and analyzing data on how an API is being used. This can include information on usage patterns, performance metrics, and user behavior, which can be used to optimize the API's functionality and improve the developer experience.

What is test environment?

An API test environment is a dedicated environment used for testing APIs (Application Programming Interfaces. The purpose of an API test environment is to provide a controlled environment for developers to test their APIs before deploying them to production.

What is production environment?

A production environment is the live or operational environment where a software application or system is deployed and used by end users. It is the environment where the application or system is running in a real-world scenario and is accessible to the public or its intended users.

Frequently asked questions