API Overview

The BoxBrownie.com V1 API is a REST API that allows you to interact with your BoxBrownie.com account programmatically. You can submit jobs, reworks, and more.

API Requests

The HTTP protocol primarily uses the GET and POST methods. In future we may add more methods. All requests should be made using https://

• GET retrieves a representation of the resource at the specified URI. The body of the response message contains the details of the requested resource.
• POST creates a new resource at the specified URI. The body of the request message provides the details of the new resource.

Resource Naming

The name and structure of our URIs uniquely identifies that resource. When you encounter a value surrounded by curly braces, you should replace it with a value appropriate to your context.

Resource URI Examples

• To insert (create) a new job in the system, we use: POST https://api.boxbrownie.com/v1/job
• To read a job with Job ID# 12345, we use: GET https://api.boxbrownie.com/job/v1/12345
• To read all jobs under your account, we use: GET https://api.boxbrownie.com/v1/job

Response Formats

We currently only support XML format for requests and responses, but may add others over time.

• All POST requests should be sent with the "application/xml" Content-Type header. Failing to set the correct content type will result in a 415 Unsupported Media Type response.
• When making a POST request ensure your XML validates against the relevant schema.

Date and times

All dates and time in the API are formatted according to ISO 8601 and will be returned in your local time zone.

Rate Limiting

The BoxBrownie.com API blocks accounts making more than 100 requests per 10 seconds. Your application will receive HTTP 429 response codes from our API if call rate limits are exceeded.

Account Credits

You must have enough credit in your BoxBrownie.com account before submitting a job. We may add an option in future to top up your account through the API.

Have a question?

Send us an email. We're happy to help!