Connect to Sovos

Register for sandbox access

Developers must register to access the Sovos developer portal, which is the sandbox environment for building and testing with Sovos APIs.

Note:

This sandbox does not give you access to products or gated documentation. For production access, register at developer-prod.sovos.com.

Go to the registration page.
Enter the required information, then click Continue.
If you see a message after clicking Continue that you do not have access, you tried to sign up for an unsupported product using a direct or incompatible link. Try registering again. If the issue continues, reach out to your team's administrator for support.
Go to your inbox, and click the verification email you received from Sovos.
In the email, click Verify.
Enter and confirm your password.
The password must:
- Be at least ten characters long
- Include one uppercase letter, one lowercase letter, and one number
- Include at least one special character: #@$!%*?&+~|{}:.-;<>/_
- Not contain any spaces
Set up two-factor authentication by following the prompts on the page.

You are logged into the developer portal.

Create API teams

Creating a team is optional. Use API teams when multiple developers need to collaborate on the same sandbox apps and share API credentials.

Log in to the Sovos developer portal.
Select the region for your team.
Click API Teams in the menu, then click + Team.
Enter a team name and a description, then enter the team members' email addresses separated by commas.
Click Save.
The success message API team created displays.

Add apps

Note:

You can only use apps created in the developer portal in the sandbox environment. To register and manage production applications, contact your Sovos account manager.

Add an app to generate API keys and secrets needed to use the API in the sandbox environment.

Log in to the Sovos developer portal.
Select the app's region.
Click Apps in the menu, then click + App.
Enter a name and description for your app.
In the APIs section, click Enable in the Actions column of the APIs you will be working with.
Click Save.
You will get a success message and will be redirected to the Apps page.

Copy the API key and the secret, which are needed to generate an access token using the API's authentication endpoint.

Edit apps

Add an app.

Log in to the Sovos developer portal.
Select the app's region.
Click Apps in the menu.
On the Apps page, click the More options icon in the app's row, then select the Edit option.
Apply any of the following changes:
1. Update the description.
2. Revoke access to the key and the secret.
3. Add another key.
4. Disable the API.
  Note:
  You can't change the app name or the app owner.
Click Save.

Sovos Docs

Connect to Sovos

Register for sandbox access

Create API teams

Add apps

Edit apps

sovos-footer