Create API credentials for your sandbox account

Your sandbox account is the perfect place for you to experiment, build and test your integrations using the Soldo Business API without any risk to your production data. To begin using the Soldo Business API with your sandbox account, you will need to create your application to generate your API credentials.

Note: The guide below describes how to generate the API credentials for your sandbox account. The process is identical for production accounts. You can find more information in the Business API Portal: Setting up the API.

Log in to your sandbox account.
From the left-side menu, select Integrations > Business API.
Select Create application.
Enter a name for your application and then follow the instructions to generate and enter a valid keypair.

Note: The key must be a valid RSA 2048-bit public key in PEM format:
```
-----BEGIN PUBLIC KEY-----
{YOUR PUBLIC KEY HERE}
-----END PUBLIC KEY-----
```
Select Next.
Next, decide what information your application will be allowed to access by selecting or deselecting the checkboxes and then select Continue.
Review your information and then scroll to the bottom of the screen to acknowledge the terms and conditions.

Note: Make sure you have read the terms and conditions before acknowledging. You can do this by following the link provided at at the bottom of the screen.
Select Create application.

Your credentials will only be shown once. Treat them as a password and store them safely. Only share them with people you trust via a secure channel.

Log in to your sandbox account.
From the main navigation menu, go to Integrations > Business API.
Select Create new application.
Enter a name for your application.

Tip: This should reflect the integration or tool it’s linked to.

Enter a public key. You’ll need to generate a valid RSA 2048-bit key pair in PEM format.

What is a key pair?

Public key: Shared with Soldo. Think of it like a username — it identifies your application.
Private key: Kept secret. It’s used to securely sign your API requests.

You can find instructions for creating a key pair using openssl during the setup flow.

Select Next.

Select the scopes your application needs and then click Continue. You can edit these later if needed.

Tip: Scopes define which parts of your Soldo account the application can access. You can choose to give read-only or full access for each area.

WC_BusinessAPI_ScopesSelectAnnotated_202512_Surface_EN.png

Review your settings and acknowledge the terms and conditions.
Select Create application

Once created, your credentials will be shown in a popup:

Client ID – identifies your application
Client secret – used for standard authentication
Fingerprint token – used for advanced authentication or downloading attachments

Important: These credentials are only shown once. Make sure you copy and store them safely before closing the popup.

WC_BusinessAPI_CredentialsAnnotated_202512_Surface_EN.png

0 people voted. Sum of votes: 0