The purpose of the zobmark API is to expose zobmark's functionalities through HTTP-based GET requests.
Below you will find links describing how you can access these functionalities, along with short examples.
You can test these API entry points through a simple unauthenticated curl in the console, as follows:
curl http://zobmark.com/api/bookmarks/?user=jondoe
Before jumping into the documentation, please note:
- The API is free to use for anyone (and will remain so), but we'll probably introduce more detailed Terms Of Service at some point.
- The API is provided as is, with no guarantee that it will be functional at any time.
- We apply rate limiting on a per IP basis, as follows: no more than 150 API requests per hour, no more than 10 requests per minute.
The API supports the following requests to retrieve and search bookmarks than have been tagged "#zob" on twitter.
All API responses will be a json object, including a status code as follows:
- 200: OK - Success.
- 400: Bad Request - The request was invalid. An accompanying error message will explain why.
- 404: Not Found - The requested URI is invalid, or the requested resource, such as a user, does not exist.
- 406: Parameter out of range - Your request uses a parameter exceeding the maximum allowed value.
- 420: Rate limiting - You have exceeded your API request limit, please back off for a while.
- 500: Internal Server Error - Something is broken. Please post to the group for the zobmark team to investigate.
- 502: Bad Gateway - zobmark is down or being upgraded.
- 503: Service Unavailable - The zobmark servers are up, but overloaded with requests. Try again later.
|