vagrant@vagrant:~$ vagrant@vagrant:~$ curl -H "X-Boxee-Auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6ImJmNzY2NTkxLTU0YTgtNGY1Yy1iN2FlLTY4OWJlODQ2YmRkZCIsImV4cCI6MTY2MTU2NzY0OSwiaXNzIjoiYm94ZWUtc2VydmljZSJ9.Aygr19ECRBB_nfkESThQ6RLZy5o29Gl-_i5SCAkBys8" -H "Content-Type: application/json" https://api.box-ee.com/api/v1/device/list | jq Q6RLZy5o29Gl-_i5SCAkBys8" -H "Content-Type: application/json" https://api.box-ee.com/api/v1/device/list | jq % % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0100 57 100 57 0 0 195 0 --:--:-- --:--:-- --:--:-- 195{ "count": 0, "devices": [], "msg": "found", "status_code": 200}vagrant@vagrant:~$ e vagrant@vagrant:~$ ex vagrant@vagrant:~$ exi vagrant@vagrant:~$ exit vagrant@vagrant:~$ exitexit
Box-ee Documentation
Back to homepage
  1. BOX-EE Documentation
  2. /
  3. Box-ee Web
  4. /
  5. Getting Started

Getting Started

BOX-EE provides a web client that is a convenient way to monitor and manage your account, devices, and tracking info.

After creating an account and verifying the provided email, you will land on the Overview page of your account.

Working with Devices

Adding a device

There is a max of 3 devices that can be registered per user

Adding a device can be done by either clicking on the Create Device for Me button or the Floating action button on the right.

Generating an API Key

API keys are generated per device. This can be generated within the device settings.

Click the device card and select the right navigation drawer to locate the device settings options

Click the generate API Key button. A one time API key will be shown. Save this as this will be given to the BOX-EE ESP32 to validate requests against your account.

Do not share this API key with anyone! To invalidate the API key, you can generate a new one using the same steps.

Tracking Numbers

After getting your BOX-EE synced with your account, you can begin adding tracking numbers to the device choose.

You can visit and manage the tracking numbers set in your device by selecting the desired device card.