Skip to main content
Kontak Sales

How to Use Sandbox or Testing Mode in Biteship

Biteship
Updated

The sandbox or testing mode in Biteship allows users to test various features and API integrations without affecting production data or making real transactions. This mode is designed to ensure that integrations run smoothly before being used live in the production environment. Here is a step-by-step guide to using sandbox mode in Biteship.

 

Steps to Use Sandbox Mode in Biteship

1. Log In to Your Biteship Account

Make sure you log in to your Biteship account first. If you don't have an account yet, you can register on the official Biteship website. After logging in, you can access all the necessary settings to enable testing mode.

general_login_1.png

2. Go to the Integration Menu

After logging in, navigate to the Integration page.

test_api_1.png

3. Enable “Testing Mode” in the Sidebar

After logging in, go to the dashboard sidebar and look for the Testing Mode option. Activate the Testing Mode toggle to switch to testing mode. By enabling this mode, all transactions you perform using the sandbox token will not affect data in the production environment.

test_api_2.png

4. Obtain the API Key for Testing

After enabling Testing Mode, you will receive a special API Key for testing. This API Key is different from the production API Key, and its token is specially formatted for testing. Make sure to use the testing token when integrating in sandbox mode so that test data does not affect real data.

test_api_3.png

5. Use the Same Endpoint for API Testing and Production

In Biteship, both API testing and production use the same endpoint. The difference lies only in the token format: make sure you use the Test API Key during testing and the Live API Key when live in the production environment.

test_api_6.png

6. Test Various API Features

You can now perform testing in sandbox mode without worrying about disturbing production data. Some features you can test include:

• Shipping Rate Checks: Test various rate scenarios based on location and weight to ensure the response is accurate.

• Creating Shipping Orders: Create test shipping orders to ensure data is sent and received correctly.

• Shipment Tracking: Track shipments using dummy tracking numbers available in sandbox mode to ensure the tracking system works.

7. Activate Production API

After all testing is complete and you are ready to switch to the production environment, you need to submit the activation form here for the live API. Biteship will verify your submission before the production API is activated. Once activated, you can start using the production API Key for real transactions.

test_api_7.png

Tips for Using Sandbox Mode Effectively

  • Use Realistic Testing Data: Enter data that closely matches real scenarios to get accurate testing results.

  • Keep Testing Records: Document every testing result to facilitate monitoring and troubleshooting.

  • Check Documentation Regularly: Changes or updates in the API documentation may affect sandbox mode, so make sure to follow the latest updates.

Frequently Asked Questions

  • Will data from sandbox mode affect production data?
    No, all data and transactions in sandbox mode only apply to the testing environment and do not affect production data.

  • Do I need a different API Key for production after testing in the sandbox?
    Yes, you need to use a special API Key for the production environment after testing is complete. An activation form is required to enable the production API Key.

  • Are there feature limitations in sandbox mode?
    Most features are available in sandbox mode, but some may have limitations to maintain the stability of the production environment.

 

If you have further questions, please contact support@biteship.com.

Related to

Related articles