Support

Getting Started

How to Register for the API Portal

Getting access to the API Portal is a simple process. Follow these steps to create your account:

Navigate to the Portal: Go to the main homepage of the Developer Portal.
Create an Account: Click the 'Sign Up' or 'Register' button, typically located in the top-right corner of the page.
Complete the Form: Fill in the required details, such as your name, company, and email address. You will also be asked to create a secure password for your account.
Verify Your Email: After submitting the form, you will receive a verification email. Click the link in this email to confirm your address and activate your account.
Log In: Once your account is activated, you can return to the portal and log in with your new credentials.

How do I start using the APIs?

Register an Application: First, create a new application in the portal. You will be issued an API Key and Secret that you must use to authenticate your API calls.
Subscribe to a Plan: Browse the available Plans and select the one that best fits your needs. Some plans are available for immediate use, while others require approval. If a plan requires approval, the API administrator will be notified to review your request and may contact you for more details.

Managing Your Applications and Security

How do I register an application?

To register a new application, click on 'Apps' in the main menu and then select 'Create new app'. After providing a name and description, your application's API Key and Secret will be displayed. .

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

I lost my API Secret. What should I do?

For security, your API Secret is only displayed once upon application creation. It is stored encrypted, and we cannot retrieve it for you. However, you can reset it.

Navigate to the 'Apps' section, select the relevant application, and click the 'Reset' link in the 'API Secret' section. A new secret will be generated and displayed at the top of the page.

How can I see my API usage?

You can view the number of requests your application has made on its page. Click 'Apps' in the main menu and select your application. The 'Product Subscriptions' table shows the plans you are subscribed to and your usage against the plan's rate limits for each API.

Understanding Key Concepts

What is a Plan?

A Plan is a collection of API resources that you can subscribe to. It can contain various operations from one or more APIs.

How do Plans manage API usage?

Each Plan has rate limits that specify how many requests your application can make within a certain time interval. A Plan might have a single rate limit for all its resources, or different limits for each one.

What is an Application?

An Application represents your project or service that will be using our APIs. When you register an application, you receive an API Key and Secret, which are the credentials needed to call our APIs securely.

API Keys and OAuth Tokens

To ensure that only authorized applications can access our APIs, we use two primary security methods: API Keys and OAuth 2.0 Tokens.
The specific method required is determined by the API you are using and will be detailed in its documentation.

Method 1: API Key & Secret
This is a straightforward method where your application is assigned static credentials that are used for every request.

How it Works:

When you register an application in the Developer Portal, you are provided with a unique API Key and an API Secret. The API Key acts like a username, identifying your application to the API.
In every API call, you must include these credentials to authenticate your application. Typically, this is done by sending the API Key in the request headers.

This method is simple and effective for many server-to-server communications. Remember to keep your API Secret confidential, as it authenticates your application.

Method 2: OAuth 2.0 with Access Tokens
This method uses a more dynamic, token-based approach for enhanced security. Instead of sending your primary credentials with every request, you exchange them for a temporary access token.

How it Works:

Request a Token: Your application makes a call to a specific security token endpoint, sending its Client ID and Client Secret (your application's API Key and Secret) to authenticate itself.
Receive a Token: The server validates these credentials and returns a short-lived access token.
Make API Calls: Your application then includes this access token—typically as a "Bearer Token" in the Authorization header—with its API requests.
Refresh the Token: This token is designed to expire after a short period. Once it expires, your application must request a new one by repeating the process.

The main benefit of this method is that your long-term API Secret is transmitted only once to get the token, not with every single API call. This limits the exposure of your primary credentials.

API Discovery and Testing

Where can I find the full API specification, including error response schemas?

Our Developer Portal provides interactive documentation for testing API operations. For the complete and official specification for a particular API, including detailed error response schemas, please view the API Product in the portal and find the link under the 'External Links' section.

We recommend using this external document as the source of truth when building your integration.

Can I test an API in the Developer Portal?

Yes, you can test REST APIs directly from the portal.

When viewing an API's details, you will see a list of its operations.
Clicking on an operation reveals more information, such as its parameters and possible return codes.
Use the 'Try' button to execute the operation. If the API requires authentication, you can enter your application's credentials (client ID or secret) in the 'Try' section.

Frequently asked questions