This documentation is in beta, and might contain errors. Contact us at integration@instabee.com with any questions.

Instabee API

Authentication

To use the Instabee API, you need to authenticate your requests using API keys. This guide explains how to obtain and use your API keys securely.

Obtaining an API Key

API keys are only issued to merchants with a contract with Instabee.

  • 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.

Your API keys carry many privileges, so be sure to keep them secure. Do not share your API keys in publicly accessible areas such as GitHub, client-side code, or in your frontend application.

Authentication Methods

All API requests must include your API key in the request headers:

1Authorization: ApiKey your_api_key_here

Required Headers

All API requests must include the following headers:

HeaderValueRequiredDescription
AuthorizationApiKey your_api_key_hererequiredAuthentication key for API access
Content-Typeapplication/jsonrequiredContent type for request body
Accept-Version1.0.0requiredVersion of the API to be used

Error Handling

When authentication fails, you will receive one of the following error responses:

Status CodeDescriptionResolution
401Invalid API keyCheck that your API key is correct and properly formatted
403Insufficient permissionsRequest additional permissions for your API key. Instabee controls which products and endpoints the key is valid for

Command Palette

Search for a command to run...