The Simpy API is available for non-commercial use by third-party developers.
Please cache data locally and be gentle with Simpy's server.
Authentication: The API uses HTTP Authentication, with Realm "/simpy/api/rest".
Note that the authentication process includes a couple
of HTTP redirects (302). Unauthenticated clients are first redirected to the
authentication handler and prompted for the credentials (username/password).
Following the successful authentication, the client is redirected back to the
original API call. See the
complete example.
- Tags
-
Returns the list of your most popular tags and their counts.
-
Removes the given tag.
-
Renames the given tag.
-
Merges two tags into a single tag. The tags to merge must be associated with the same link.
-
Splits the given tag into two tags.
- Links
Depending on your input parameters, this call returns your most recent
links, links added on or between given dates, or links matching a
given query, or links with a given tag.
Saves the given link and returns a status reponse indicating either success or failure.
Deletes the given link and returns a status reponse indicating either success or failure.
- Watchlists
Returns the list of your Watchlists, their meta-data, including the number
of new links added to each Watchlist since your last login.
-
Returns the meta-data for a given Watchlist.
- Notes
Returns all your Notes in the reverse chronological
order by add date (i.e. the most recently added Note
first) or by rank, if you use this in the search mode.
Saves a new Note and returns a status reponse indicating either success or failure.
Deletes a Note and returns a status reponse indicating either success or failure.
Request Authentication Example
$ GET -UusSed http://simpy.com/simpy/api/rest/GetTags.do
Enter username for /simpy/api/rest at simpy.com:80: demo
Password:
GET http://simpy.com/simpy/api/rest/GetTags.do
Authorization: Basic ZGVtbzpkZW1v
GET http://simpy.com/simpy/api/rest/GetTags.do --> 302 Moved Temporarily
GET http://simpy.com/simpy/api/rest/HTTPLogin.do?_doneURI=%2Fsimpy%2Fapi%2Frest%2FGetTags.do --> 401 Unauthorized
GET http://simpy.com/simpy/api/rest/HTTPLogin.do?_doneURI=%2Fsimpy%2Fapi%2Frest%2FGetTags.do --> 302 Moved Temporarily
GET http://simpy.com/simpy/api/rest/GetTags.do --> 200 OK
In English:
- Request the API URI
- Unauthenticated requests are detected and sent to HTTPLogin, the authentication handler, with a 302
- HTTPLogin responds with a 401 and asks for credentials, which the client provides
- If credentials were correct, the HTTPLogin redirects the client to the original URI via a 302, and the client gets the XML response
simpy
