Gettin’ Started:

The SalesBinder API is a RESTful interface designed for those interested in developing 3rd party code to communicate securely with our platform. We strongly recommend having programming experience before considering reading any further – just a heads-up!

What is the SalesBinder API used for?

Using our API you can fully control your SalesBinder account data using 3rd party software or even create your own home-made scripts. You’re able to integrate your inventory data into a website, display stock levels in real-time, and even take it a step further by integrating into an e-commerce shopping cart so SalesBinder can create invoices while managing your stock levels automatically. In addition to this you could also create your own mobile apps, extend SalesBinder’s core functionality, or anything else you can think of.

First Things First: Generate an API Key

Generate a new API Key by going into your “Profile” once logged into SalesBinder. You’ll find a button at the bottom that says “Generate New API Key”, click it and you’re done. There’s more info here in case you’re already lost.

The generic format for the API endpoint:

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

Note: The API can be formatted in either JSON or XML (.json or .xml).

General API Method Formatting

Index (GET): http://[subdomain].salesbinder.com/api/[method].[format]

View (GET): http://[subdomain].salesbinder.com/api/[method]/[id].[format]

Create (POST): http://[subdomain].salesbinder.com/api/[method].[format]

Edit (PUT): http://[subdomain].salesbinder.com/api/[method]/[id].[format]

Delete (DELETE): http://[subdomain].salesbinder.com/api/[method]/[id].[format]

API Method Categories

Data Validation Error Formatting

JSON:

{“Errors”:[{“Error”:{“message”:”message 1”}}, {“Error”:{“message”:”message 2”}}]}

XML:

<errors>
  <error>
    <message>message 1</message>
  </error>
  <error>
    <message>message 2</message>
  </error>
</error>

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 at least 5 minutes, 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.