Shoeboxed.com » API (For Developers)

What character encoding does the Shoeboxed API use?

sonnybyrd — Thu, 20 May 2010 21:51:34 +0000

We assume a UTF-8 encoding for all communication with the Shoeboxed API.

Can Shoeboxed promote the application I built using the Shoeboxed API?

sonnybyrd — Thu, 20 May 2010 21:50:00 +0000

After you have built your integration, please contact us to let us know about it. If we think that your app brings value to our users, we will certainly let them know about it and will consider integrating your company into our Shoeboxed Partners platform.

Am I allowed to use the Shoeboxed API on my site?

sonnybyrd — Thu, 20 May 2010 21:48:13 +0000

You can use the Shoeboxed API for commercial and non-commercial applications, deployed on a web site, mobile device or as a desktop application.

Can I use the Shoeboxed API on a password protected site?

sonnybyrd — Thu, 20 May 2010 21:45:16 +0000

Yes, you may use the API on password protected sites as long as you abide by the Shoeboxed API Terms of Service.

What application names or domain names can I use for applications that I build onto the Shoeboxed platform?

sonnybyrd — Fri, 14 May 2010 01:48:13 +0000

For legal reasons, we do not allow you to use the word “Shoeboxed” or “Shoe”xxx or xxx”Boxed” in any domain name or application name without prior approval from us. Please contact us at help[at]team.shoeboxed.com with any questions.

What limits do you put on applications?

sonnybyrd — Fri, 14 May 2010 01:47:03 +0000

Please make sure to review our API Terms of Service when developing an application using Shoeboxed’s API.   The Terms of Service is mainly to protect our users and their privacy. If you are planning an application that does not infringe on user privacy, we don’t expect there to be any worries about the Shoeboxed API Terms of Service. We are happy to review application ideas on a case by case basis.   If you have any questions or concerns about the Terms of Service, please don’t hesitate to contact us at help[at]team.shoeboxed.com. 

What content am I allowed to display or store?

sonnybyrd — Fri, 14 May 2010 01:45:31 +0000

All content delivered to your application can be displayed to the user.   In general, content delivered when the user is logged in should only be stored until that users’ session expires.   There are a few exceptions to this policy. You can store receipt IDs in your application. This is detailed further in the API Documentation and API Terms of Use.

Is there a limit on the number of requests I can make to the Shoeboxed API?

sonnybyrd — Fri, 14 May 2010 01:43:46 +0000

We currently have an API request limit of 50,000 requests in a rolling 24 hour window. This is to help us limit load on our servers.   We return an error code if your request limit has been exceded.   If you wish to request additional requests, please contact help[at]team.shoeboxed.com. We will do our best to make sure your request is honored.

How long does the user session last?

sonnybyrd — Fri, 14 May 2010 01:41:41 +0000

User sessions last 24 hours. After this period of time, the user will need to reauthenticate.

Do you support or plan to support SOAP?

sonnybyrd — Fri, 14 May 2010 01:40:38 +0000

We will support SOAP at a later time. If you are looking for a SOAP implementation of the Shoeboxed API, please contact us at help[at]team.shoeboxed.com for the status of the SOAP implementation.

What is REST?

sonnybyrd — Fri, 14 May 2010 01:39:19 +0000

REST is a protocol used by many APIs for transfer of data over HTTP.   REST stands for Representational State Transfer. The Wikipedia entry on REST has a good deal of information about the protocol.

How does the API key system work?

admin — Tue, 11 May 2010 22:32:31 +0000

Every application that uses the Shoeboxed API must have a unique Shoeboxed API key. This key is included with every API call to identify your application to our servers.   To get your API key, start a Shoeboxed account HERE. Then log into your account, click on Account and Settings in the upper right-hand corner , then choose Developers. Obtain an API key and start coding!