Your Royal Mail Account Number (OBA number) is required for supporting your queries and API integrations. If you subscribed to Shipping, Tracking or Local Collect APIs and did not include your 10 digit Royal Mail OBA Account number in the APP name, your subscription will be rejected.
Is it possible to test an API before signing up to a plan?
It is possible to test a REST API from this Developer Portal once you have subscribed to and have been approved access to the API. For SOAP APIs, currently you will need to test from within your own system. You can use the support page to raise a support ticket with the customer solutions team for testing assistance.
When looking at the details of a REST API you will see a table of the Resources contained in the API. This will show what method they are (GET, POST, PUT or DELETE) and what path the Resource uses.
If you click on the Resource 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 it out' button which enables you to try the Resource out direct from the Developer Portal.
If the API requires a client ID or a client secret for identification then you can specify these at the top of the 'API Resources' section.
The plan I subscribed to has a limited amount of calls per API. How can I monitor my usage against that?
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. Under 'Subscribed Plans' 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.
When you add an application you are provided with a client ID and client secret for the application. You must supply the client ID when you call an API that requires you to identify your application by using a client ID, or a client ID and client secret.
To register an application click on Apps in the main menu and then click on the 'Register an application' link. Once you have provided an application name, description, etc you will be shown your application client ID and client secret.
Make a note of your client secret because it is only displayed once. You must supply the client secret when you call an API that requires you to identify your application by using a Client ID and Client secret.
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 API. A plan can contain a mixture of HTTP GET, PUT, POST, and DELETE verbs from different APIs or it can contain all the GET verbs from various 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.
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. If you find the plan does not meet your needs, then contact the customer solutions team via the support page for assistance.
I have forgotten my application client secret. How can I reset it?
Your application client 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 'Client Secret' section.
Your new secret will be displayed at the top of the page.