Oauth

The key to secure access to all APIs.

Oauth is the authentication service for API usage and provides secure management of requests and integrations

Some small tricks:

  • check if you have already activated the API or scope for which you are requesting the token
  • check if you have already activated your sandbox account before creating the token in test
  • check if you have followed all the instructions in Documentation > Quick Start at the level of each API

If you are unable to generate it via an API request, try the dedicated tool in Authentication.

Still having problems? Fill out the form in the Help section.

Yes, you can delete the token in the Authentication section and by clicking on the recycle bin icon.

You can check your remaining credit

  • with a request to the GET /credit endpoint
  • by accessing the console: at the top, the amount is always updated

You can monitor the consumptions of all APIs, yearly, monthly and daily through dedicated endpoints (counters).

In the Console, there is also a dedicated section, Usage, at the individual API level, which allows you to view your individual (including free) and subscription requests, both graphically and in table form.

Once you have activated your sandbox account, you can select the desired top-up amount for your test environment under Preferences.

There is no real cost, you will simply create a virtual account for testing in an environment identical to the production environment.

ATTENTION: It is important to top up your credit, otherwise requests will be in error.

To activate your sandbox account click on the "ACTIVATE SANDBOX" button directly from the Dashboard (or the Authentication section) and complete the form.

Please note that you need to virtually top up your sandbox credit in order to test. It is also important to use the dedicated servers for test requests.

The token, whether test or production, has a default expiration of one year, but we recommend setting shorter durations for security reasons.

The list of tokens, sandbox and production, is available in the Authentication section.

You can request token information via the dedicated endpoints:

  • GET/token to get the list of all non-expired tokens
  • GET /token/{token} to get details about a specific token such as expiry and associated scopes

The sandbox token is needed to make requests in the test environment and can only be created after activating the sandbox account.

The production token is needed, as the name already indicates, to make your requests when you publish in production. The production token can only be created for already activated APIs or scopes.

To create your token you can use:

  • the dedicated "New Token" tool in the Authentication section
  • the Post /Token endpoint of the Oauth API. In this case you must use the APIKey also available in the Authentication section.

You can create tokens for both the test (sandbox) and production environment.

Please note that the production token can only be created for already activated APIs or scopes and the test token can only be created after activating the sandbox account.

You can access your APIKey, both test and production, in the Authentication section. You can also update your APIKey in the same section.

The APIKey is required for the creation of the first token.