API Documentation

Overview

By and large we're attempting to replicate the API provided by datakick.org (no longer available). Consequently the text here has been copied from the Datakick API documentation, at least to get things started. We'll update and refine the documentation as we go.

Currently Brocade.io has no support for images. Write access is available, albeit a little clunky. Refer to the project's README file for early-adopter access.

Find an item

Lookup an item by UPC or EAN

GET https://www.brocade.io/api/items/000000000000

Find an item

Lookup an item by UPC or EAN

GET https://www.brocade.io/api/items/000000000000

List items

GET https://www.brocade.io/api/items

Up to 100 items are returned by default.

Pagination info is returned in the Link header.

To search items, use the query parameter.

GET https://www.brocade.io/api/items?query=peanut+butter

Header Pagination Info

Header - links - First Header

https://www.brocade.io/api/items?page=20&query=peanut+butter; rel="last", https://www.brocade.io/api/items?page=2&query=peanut+butter; rel="next"

Header - links - Subsequent Headers

NB include the previous and https://www.brocade.io/api/items?page=1&query=peanut+butter; rel="first", https://www.brocade.io/api/items?page=1&query=peanut+butter; rel="prev",

Header - per-page & total

per-page - Results per page = 100 total - Total number records = 1912 total / per-page = Total Pages 19.12 rounded up = 20. Total is also found in Header - links last