ToolBox -

Updated: Mar 9th, 2013

Print this article

Our SalesBinder REST API is designed for those interested in developing and integrating 3rd party code to communicate securely with our platform.

We strongly recommend having some programming experience before attempting to work with any API. Just a heads-up!

Gettin’ Started:
Generate a new API Key by going into your “Profile” once logged into SalesBinder. You’ll find a button that says “Generate New API Key”. Only your account administrator has access to generating the API Key for now so if you don’t see it, you’ll have to contact the person that created your SalesBinder account.

The general URL structure:

http://[apikey]:x@[subdomain].salesbinder.com/api/[model].[format]

Note: The API can be formatted in either JSON or XML.

Methods

Items (Inventory List)

The Items list is paginated. You can pass the “page” query string parameter followed by a number to access the other pages. You can also pass the “categoryId” parameter to access items for a particular category. This will return all of the details for items. The pagination limit is currently set to match your SalesBinder account (16 per page).

Syntax:
http://[subdomain].salesbinder.com/api/items.json

or

http://[subdomain].salesbinder.com/api/items.xml

Example:
http://demo.salesbinder.com/api/items.json?page=2&categoryId=979db3a8-f7fc-4b73-ba05-b87abfbf6e5e

Item Details

To get the details of a specific inventory item, you simply need to pass the item “id” query string parameter.

Syntax:
http://[subdomain].salesbinder.com/api/items/[id].json

or

http://[subdomain].salesbinder.com/api/items/[id].xml

Example:
http://demo.salesbinder.com/api/items/5487185e-b83f-46c2-bb91-2416ae304d03.json

Categories (Inventory Categories List)

Just like Items, the Categories method is paginated too. You can pass the “page” query string parameter followed by a number to access each of the pages. The pagination limit is currently set to match your SalesBinder account (16 per page).

Syntax:
http://[subdomain].salesbinder.com/api/categories.json

or

http://[subdomain].salesbinder.com/api/categories.xml

Example:
http://demo.salesbinder.com/api/categories.json?page=5

Connection Limits

We currently do implement connection limits to our API so be sure to write your scripts efficiently. If you’re integrating our API into your public facing website, we recommend caching your data for 5 minutes or so. This way if your website receives a lot of activity you won’t have to worry about the API temporarily cutting you off.

Not A Programmer?

The SalesBinder API is basically for nerds only. If you’re not a programmer, and you don’t have one in your company that you can bribe, feel free to get in touch with us and we’d be more than happy to quote you on building your project.