Background
These API tokens allow you to call all Synchronous API and generate a static response irrespective of the payload that you’re sending to the API. These tokens generate API responses that do not cost anything to the user. This is very helpful when the Batchdata customer is developing an integration with Batchdata API.
Generating Sandbox API Tokens
Navigate to https://app.batchdata.com/dashboard.
Click on the “Key” icon (API Tokens) on the left hand side menu.
Click "Sandbox API Tokens"
Click "Add New Token"
Click the "Name" field and enter a relevant name for the token.
Click “Create”.
Copy the token generated - this will not be displayed again.
Click “Close”
Disable Sandbox API Token
Navigate to https://app.batchdata.com/dashboard
Click on the “Key” icon (API Tokens) on the left hand side menu.
Click "Sandbox API Tokens"
Locate the token you’d like to disable, and click the “Disable” button next to the token.
Click “Disable” to confirm.
Enable Sandbox API Token
Navigate to https://app.batchdata.com/dashboard
Click on the “Key” icon (API Tokens) on the left hand side menu.
Click "Sandbox API Tokens"
Locate the token you’d like to enable, and click the “Enable” button next to the token.
Click “Enable” to confirm.
FAQs
What is a sandbox API token?
A sandbox API token is a secure credential used for authenticating API requests within a testing or development environment; it simulates production interactions.
When is a sandbox API token used?
This is typically used when you're in development or testing phase. Once done, you replace this token with Production API token.
Are the API calls made using sandbox API tokens chargeable?
No. Sandbox API tokens are not subject to any charges, either from your in-app wallet or towards your subscriptions quota. They're free of charge and primarily used to simulate production response while testing your system under development.
Why should I use sandbox API tokens?
Sandbox API tokens allow you to safely test API endpoints, flows, and edge cases without risking real transactions. All API calls made using sandbox API token are not chargeable.
Are API sandbox tokens subject to rate limits?
Sandbox API tokens are subject to the same API rate limits as that of production API tokens.
Do sandbox API tokens yield real production data, and is it usable?
No, sandbox API tokens yield a dummy response data irrespective of the request payload sent to the API. This is helpful in simulating API responses when under development, and reduce costs when you're under development or testing.
NOTE - The sandbox API responses are not always up to date or in sync or may not contain all the attributes as compare to Production API responses. Its always recommended to run a final test using a Production API token.
What is the URL for calling API when using sandbox API tokens?
The API URL for using sandbox API tokens is same as that of the Production API URLs as mentioned in the developer documentation here.
I'm not getting any response on my webhook URLs when using Sandbox API tokens for Async API.
When using Sandbox API tokens, both the Async and Sync APIs work in the same manner, i.e. you'll immediately get a response to your API call instead of getting a response on your webhook URL in case of Async API.