URL

API URL

The URL of the API is https://digitalbusiness.cards/api/{api_version}. The URL of the latest version is https://digitalbusiness.cards/api/v1.0/

Eligibility

Who is able to utilise the API

The API is only available for paid accounts. Free accounts unfortunately do not have a permission to use it.

Authentication

How to start using the API

The DBC API uses a token to authenticate requests. You can view and manage your API keys in the Admin page to get the token. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Please use GET /api/{api_version}/Login/{your_API_key} to get the token and set the received token in HTTP Header as Authorization: Bearer xxxxxx. The token will expire in 60 mins.

For instance, if you want to get your account information, please send a request like:

Need a new token when the token expires?

Yes, if the reveived token expires, you need to request a token again to access the API.

Where API Key

Please login and go to 'Profile' page. You are able to generate/regenerate your API key. The API is only available for paid accounts and for business accounts, users of the account manager role are only available to access the API section.

Swagger

What is Swagger

Swagger UI facilitates testing and visualising the API. Please use the UI to test any requests such as getting a token and your account information. URL: https://digitalbusiness.cards/api/swagger

Need a token to use Swagger UI?

Yes, you need a token to use Swagger UI. Please use a below method, 'Login' to get a token and set the token in a below textbox.