All you need to start using the API
Prerequisites of using the API
You can test the DigiTax API before reaching out to us
We've designed the developer experience to be Hands-off. Meaning you can get started with your first API call without engaging with our team. Should you need our support or want to onboard your business to LIVE, reach out to us.
The following are the steps to creating a sandbox business and getting an X-API-Key (for testing before you go LIVE):
- Sign up on DigiTax
- Create a profile.
- Create a sandbox business.
- Generate an API Key under the "Integrations" tab. See screenshots below.
- Use the copied API Key as X-API-Key in your header when making API calls through the interactive API docs here OR via your integration during testing.
See screenshots below.
Generate an API Key
In a Sandbox/ LIVE business,
- Navigate to the "Integrations" menu tab
- Select "Add API KEY"
Add API Key
- Enter a name and select "Api key"
Create an API Key
Please record the value that you generate for later use, as you will not see it from the dashboard on subsequent visits. Save it securely.
License Key
In step 3 above, under API Type, we have two options:
- Api Key
- License Key
The License Key is used in some DigiTax Plugins.