Once you decide to start your integration with byrd, you need a demo account. It is a byrd account connected to a demo warehouse, where you can build and test your integration without moving any physical products.

How to request a demo account

If you already have an account on our Support page, please create a ticket asking for a demo account for your API integration.

If you don't have an account on our Support page, please contact us, mention that you would like a demo account to test an API integration, and we'll be happy to help.

After receiving your demo account

You will receive the user credentials for your dashboard. Your demo account may already contain some sample products, a starter delivery and example orders. You can use them, or create your own through the dashboard or the API.

Creating your API credentials

You create the API key and secret yourself in the dashboard:

1. Log in to your dashboard and go to Settings > API Keys.

   

2. Click Add API Key.

3. Enter a Context that describes what the key is for (for example "Warehouse integration") and a Technical contact email, where we will send notices about API changes.

   

4. Copy the Key and the Secret. The secret is only shown once: it cannot be shown again after you close the dialog.

   

Use the key and secret to get your token. You can create more keys or delete the ones you no longer need at any time. Deleting a key stops any integration using it immediately.

❗️

Keep your credentials in a safe place

Your user credentials and API keys should be stored safely and securely. This is important to prevent others from accessing them and using your account or API to perform malicious activities. When storing API keys, it is important to store them away from other parts of your system or your code repository, and to make sure they are stored in an encrypted format.

📘

Set up your company details

The first time you access your dashboard, remember to set up your company details, including the billing address, under Settings > Company Profile.

Processing your test deliveries and shipments

In your demo account you can create products, deliveries and shipments just like in production. No warehouse processes them and no physical products are moved or shipped. Instead, you use the warehouse simulator in your dashboard to do the warehouse's work yourself: receive your deliveries so the stock is updated, and pick, pack and send your shipments so they get labels and tracking data. Your integration sees each step through the API, exactly as it would in production.

See Using the warehouse simulator to learn how.

📘

Fair use

Demo accounts are intended for development purposes. We kindly ask that you don't create a large volume of products or shipments without first consulting byrd.