Skip to main content
Kontak Sales

How to Obtain an API Key for Integration

Biteship
Updated

An API Key is a unique code required to access the Biteship API and authenticate every request to the system. This API Key ensures that only authorized parties can access the delivery services provided by Biteship. Here are the steps to obtain your API Key and start integrating with Biteship.

 

Steps to Obtain a Biteship API Key

 

1. Register or Log In to Your Biteship Account

If you do not have an account yet, register first on the Biteship website. If you already have one, log in to your account using your registered email and password.

general_login_1.png

2. Navigate to the Integration Section

After logging in to the dashboard, look for the Integration menu.

api_1.png

3. API Key Settings

On the API page, select the Settings option under the API Key section. You will be directed to the API key creation page.

api_2.png

4. Create a New API Key

On the API page, select the Add API Key option.

api_3.png

5. Provide a Name for the API

You will be asked to give a name or label for this API Key, for example “Online Store Integration” or “API for Mobile App,” so you can easily identify it.

api_4.png

6. Keep Your API Key Secure

Once the API Key is generated, save it in a secure place. The API Key serves as a unique identity that grants access to the Biteship system, so it is important not to share it carelessly. If the API Key is misused, your data or services could be at risk.

api_5.png

7. API Successfully Created

Before you start using it, test the API Key to ensure the connection works properly. You can try sending simple requests, such as rate checking or shipment tracking, to verify that your API Key is successfully connected to Biteship.

api_6.png

Tips for Managing API Keys Securely

  • Store API Keys in a Private Place: Do not place API Keys in source code or locations easily accessible to the public. Use environment variables or secure storage systems.

  • Delete Unused API Keys: If you no longer use a particular API Key, delete it to reduce the risk of misuse.

  • Rotate API Keys Periodically: For added security, change API Keys periodically, especially if you suspect any potential risks.

Frequently Asked Questions

  • Can I have more than one API Key?
    Yes, you can create multiple API Keys for different integration purposes, such as for different applications or teams.

  • Is there an additional fee to create an API Key?
    No, Biteship does not charge extra fees for creating API Keys. You will only be charged based on the usage of the delivery services you access through the API.

  • What should I do if my API Key is exposed or misused?
    If your API Key is exposed or misused, immediately delete the API Key from the Biteship dashboard and create a new one to replace it.

 

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

Related to

Related articles