Oauth V2

  1. Home
  2. API Library
  3. Oauth V2
The key to secure access to all APIs.

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

All the knowledge you need

Here you can find some advice to consider to approach this API. If you prefer, we provide code samples, OAS3 documentation, the ability to try the API live via the Swagger UI or import the entire collection into Postman. We also offer a Sandbox environment where you can experiment with all kinds of requests completely free of charge.

Useful tips to start with Oauth V2

Get the token in the appropriate section before you start.

Use the the online tool or generate it via API. Set the expire date, a usefull name and now add a bunch of scopes to limit the possible actions your token can do.
Read more on oauth API Manage my tokens

1) Create your first token.

Create a token with one or more scopes to authorize downstream API calls. You can set name, TTL and limits (total requests, paid requests, wallet amount and IP whitelist).
Create token (POST /tokens) List tokens (GET /tokens)

2) Manage token lifecycle.

After creation, retrieve token details, update scopes/limits/TTL and remove unused tokens. PATCH supports the refresh-token flow for secure token rotation.
Token detail Update token Delete token

3) Check available scopes.

Retrieve the scopes enabled for your account and inspect scope details, including domain, endpoint and requirements.
List scopes (GET /scopes) Scope detail (GET /scopes/{id})

4) Monitor wallet and transactions.

Use wallet endpoints to get your current credit and inspect the latest wallet transactions with pagination support.
Wallet balance (GET /wallet) Wallet transactions

5) Read usage statistics.

Access aggregate usage data for requests, paid calls and errors. You can inspect totals, IP lists and per-domain API metrics.
Global stats (GET /stats) API stats (GET /stats/apis) IP stats (GET /stats/ips)

6) Inspect callbacks, subscriptions and errors.

Use monitoring endpoints to troubleshoot callback deliveries, verify active subscriptions and review integration errors.
Callbacks Subscriptions Errors
Redoc missing.
Web Service Revision: 2.0.0