BOX-EE Documentation

The BOX-EE project is in beta stage and as we continue to iterate, we’ll continue to work on providing the best experience for our users.

Your feedback is extremely valuable so please reach out with either an email to epuerta@box-ee.com or a general post in our discord server

BOX-EE is an IOT smart box that focuses on the safety of deliveries. It pairs with a free cloud account that allows you to transform your tracking number into a one-time security key.

We at BOX-EE have personally experienced both damaged packages and stolen packages so we directed our frustration to building and creating a community driven project that aims at solving this pain point.

Build your own DIY BOX-EE IOT box with our tutorials as we hope to foster a community of builders and developers for this platform.

This project is for ANYONE with ANY level of experience. We provide all the tools and documentation needed. If there are any questions, post them in the BOX-EE discord channels where others can also help.

There are 3 main components of the BOX-EE project

BOX-EE platform offers the following

• Cloud Web Platform

• Open source CLI

• Open source BOX-EE IOT Code

• BOX-EE schematics, bill of materials, and how-to’s

• Community support and help

• Login/Register

  After registering, an email verification link will be sent and must be verified before signing in. As of 11/22/2022, the email verification link will be sent from our identity management provider Ory. Check your spam folder if you did not receive an email from BOX-EE via Ory.

  Web

  1. Go to BOX-EE web
  2. Register an account
     • Verify email
  3. Login with email and password

  API

  1. Register

  curl -X POST -d '{"email":"you-email","password":"your-password"}' -H "Content-Type:application/json" https://api.box-ee.com/api/v1/self-service/register | jq
  
  {
    "msg": "registration successful",
    "status_code": 200
  }
  

  2. Login

  curl -X POST -d '{"email":"you-email","password":"your-password"}' -H "Content-Type:application/json" https://api.box-ee.com/api/v1/self-service/login | jq
  
  {
    "msg": "login successful",
    "session_token": "your-session-api-token",
    "status_code": 200
  }
  

  CLI

  1. Install latest release

  curl -o boxee.zip -L $(curl -s https://api.github.com/repos/epuerta9/box-ee-cli/releases/latest | jq .zipball_url -r) && unzip boxee.zip
  
  esteban@xps15:boxeeclidemo$ ls
  boxee.zip  epuerta9-box-ee-cli-291d839
  

  2. (Optional) Move binary to your PATH

  sudo mv epuerta9-box-ee-cli-291d839/bin/boxee /usr/local/bin
  

  3. Create box-ee config file

  esteban@xps15:boxeeclidemo$ ./boxee init -e your-email
  running init config
  
  esteban@xps15:boxeeclidemo$ cat .box-ee.yaml 
  address: https://api.box-ee.com
  email: your-email
  

  4. Register

  esteban@xps15:boxeeclidemo$ ./boxee register -e your-email -p your-password
  

  5. Verify your email

  6. Login

  esteban@xps15:boxeeclidemo$ ./boxee login -p your-password | jq
  {
    "msg": "login successful",
    "session_token": "your-api-token",
    "status_code": 200
  }
  

• Add your first device

  Web

  1. Click the floating plus icon on your home page
  2. Specify the following
     • Name - a friendly identifier for your device
     • Type - a descriptive label usually indicating what kind of device
       • i.e outdoor, main, front door.

  API

  curl -H "X-Boxee-Auth: your-session-token" -H "Content-Type: application/json" -d '{"device_name": "default", "device_type": "main"}' https://api.box-ee.com/api/v1/device | jq
  

  {
    "device_id": "ba4759df-4787-4110-a744-1530da326a6d",
    "device_name": "default",
    "device_type": "main",
    "msg": "created",
    "status_code": 202
  }
  

  CLI

  ./bin/boxee device add
  

  {"device_id":"f4431800-806a-45d9-b7cf-0fae3d0659d4","device_name":"default","device_type":"main","msg":"created","status_code":202}
  

• Send a tracking number

  Web

  1. Click the device card you want to add a tracking number to
  2. Open the right navigation drawer
  3. Select “Add Tracking Number”
  4. Submit tracking number

  API

  curl -X POST -H "Content-Type: application/json" \
  -H "X-Boxee-Auth: your-api-token" \
  -d '{"tracking_number": "12345678", "device_id": "device-id-string"}' \
  https://api.box-ee.com/api/v1/tracking| jq
  

  {
    "msg": "created",
    "status_code": 202
  }
  

  CLI

  ./boxee tracking add --tracking-number 12345678
  

  {
    "msg": "created",
    "status_code": 202
  }
  

curl -o boxee-client.zip -L $(curl -s https://api.github.com/repos/epuerta9/box-ee-client/releases/latest | jq .zipball_url -r) && unzip boxee-client.zip

We value everyone that is part of the community and encourage people to connect with us on Discord.

Reach out and say hello!

• Getting Started IOT