Authentication
The Budbee API uses HTTP Basic Authentication. Encode your API key and secret as base64(apiKey:apiSecret) and pass it in the Authorization header.
Obtaining an API Key
API keys are only issued to merchants with a contract with Budbee.
- No contract yet? Please fill in your details on our contact form or email sales@instabee.com. Please do this before reaching out to the integration team.
- Already have a contract? Talk to your Implementation Manager. If you do not have a contact, please reach out to integration@instabee.com.
Header Format
1Authorization: Basic base64(apiKey:apiSecret)1Authorization: Basic base64(apiKey:apiSecret)
Example
If your API key is myApiKey and your secret is myApiSecret:
1echo -n "myApiKey:myApiSecret" | base64 2# bXlBcGlLZXk6bXlBcGlTZWNyZXQ=1echo -n "myApiKey:myApiSecret" | base64 2# bXlBcGlLZXk6bXlBcGlTZWNyZXQ=
Then include it in every request:
1curl -X GET https://api.budbee.com/postalcodes/validate/SE/11353 \ 2 -H "Authorization: Basic bXlBcGlLZXk6bXlBcGlTZWNyZXQ=" \ 3 -H "Accept: application/vnd.budbee.postalcodes-v2+json"1curl -X GET https://api.budbee.com/postalcodes/validate/SE/11353 \ 2 -H "Authorization: Basic bXlBcGlLZXk6bXlBcGlTZWNyZXQ=" \ 3 -H "Accept: application/vnd.budbee.postalcodes-v2+json"
Environments
| Environment | Base URL |
|---|---|
| Production | https://api.budbee.com |
Use the same credential format for all requests to the production environment.
Webhook Authentication
Budbee supports two authentication modes for webhooks:
| Version | Authentication |
|---|---|
| V1 Webhooks | HTTP Basic Auth (username + password configured per webhook) |
| V2 Webhooks | HTTP Basic Auth or OAuth2 (configured in the Budbee merchant portal) |
Error Responses
| Status Code | Description | Solution |
|---|---|---|
401 | Missing or invalid credentials | Check your Authorization header encoding |
403 | Access denied | Your credentials do not have access to this resource |