API Documentation

This document contains information about using Boxmeup's API.

Legal Notice

Boxmeup’s API is not to be used to duplicate the service. It is meant for integration with other services and software. API access can be denied at will.

Authentication

Boxmeup uses an form of OAuth to authenticate requests to various resources.

See the User Resource section on how to acquire an authentication token.

All requests to any API resource must have an authentication header that contains the authentication token provided by the user resource. This authentication header should look something like the following:

Authentication: BoxmeupAPI token=<your token here>

An example cURL request using the above header would look something like:

curl -H "Authentication: BoxmeupAPI token=28f98f0b91db02b8480b9d91ac6c7cd183731e4b" https://boxmeupapp.com/api/containers

This would validate your request with your OAuth token and provide a list of all your containers.

User Resource

» POST /api/users/login

• Acquire an OAuth token with provided credentials for an application.
• Parameters:
  • emailRequired - Email address of an account.
  • passwordRequired - Password of an account.
  • applicationRequired - Application name to associate token.
• Example:

  curl -d "[email protected]&password=test1234&application=Test Application" https://boxmeupapp.com/api/users/login
  
  {
  	"token": "1cd2b6edc30afc5e0e8084c83601506de69f53a3"
  }
  					

Container Resource

» GET /api/containers

• Get a list of all containers.
• Parameters:
  • slugOptional - Slug of a container to retrieve a specific container.
• Example:

  curl -H "Authentication: BoxmeupAPI token=testtoken" https://boxmeupapp.com/api/containers
  
  [
      {
          "Container": {
              "container_item_count": 1,
              "created": "2013-08-11 01:33:31",
              "modified": "2013-08-11 04:27:44",
              "name": "Test",
              "slug": "test",
              "uuid": "5206e9eb-8e8c-49b9-bced-087921210046"
          },
          "Location": {
              "name": null,
              "uuid": null
          }
      }
  ]
  					

» POST /api/containers

• Creates a new container.
• Parameters:
  • nameRequired - Name of the new container.
• Example:

  curl -H "Authentication: BoxmeupAPI token=testtoken" -d "name=Test" https://boxmeupapp.com/api/containers
  
  {
      "slug": "test-1",
      "uuid": "520713ad-1a50-4cce-a450-086421210046"
  }
  					

» PUT /api/containers/<container-slug>

• Updates an existing container.
• Parameters:
  • nameRequired - Rename the container to this name.
• Example:

  curl -X PUT -H "Authentication: BoxmeupAPI token=testtoken" -d "name=Test 2" https://boxmeupapp.com/api/containers/test-1
  
  {
      "Container": {
          "container_item_count": 0,
          "created": "2013-08-11 04:31:41",
          "modified": "2013-08-11 04:31:41",
          "name": "Test 2",
          "slug": "test-1",
          "uuid": "520713ad-1a50-4cce-a450-086421210046"
      },
      "Location": {
          "name": null,
          "uuid": null
      }
  }
  					

» DELETE /api/containers/<container-slug>

• Updates an existing container.
• Example:

  curl -X DELETE -H "Authentication: BoxmeupAPI token=testtoken" https://boxmeupapp.com/api/containers/test-1
  
  {
      "success": true
  }
  					

» GET /api/containers/search

• Search containers for an item.
• Parameters:
  • queryRequired - Search query.
• Example:

  curl -H "Authentication: BoxmeupAPI token=testtoken" https://boxmeupapp.com/api/containers/search?query=test
  
  {
      "pages": 1,
      "search": [
          {
              "Container": {
                  "container_item_count": "1",
                  "created": "2013-08-11 01:33:31",
                  "modified": "2013-08-11 04:27:44",
                  "name": "Test",
                  "slug": "test",
                  "uuid": "5206e9eb-8e8c-49b9-bced-087921210046"
              },
              "ContainerItem": {
                  "body": "test",
                  "created": "2013-08-11 01:33:33",
                  "modified": "2013-08-11 01:33:33",
                  "quantity": "1",
                  "uuid": "5206e9ed-45b4-46ce-a423-087921210046"
              }
          }
      ],
      "total": 1
  }
  					

Container Item Resource

Not ready for release.

Location Resource

Not ready for release.