Authentication

Boxme API use token based as its authentication mechanism

Get API key

Before you can start using our APIs, you need an API key. It's easy. Just visit https://oms.boxme.asia and sign in with your account. Next step go to Settings menu -> API Intergration to create API key.

Once you've activated your key, you're ready to roll.

:::highlight yellow 💡
Please keep your API KEY in a secret and secure manner. DO NOT store them in publicly accessible places like GitHub, client-side code and so on.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
:::

Headers

To use the Boxme API key, construct a normal HTTPS request and include an Authorization header with the value of Token. Signing is not required.

Example of request headers:

Authorization: Token 424d0db4e09024c3f29120972ddb747d34e721941e33bace61eb6fced161ac85