Rest API
Introduction
The Noopsi Rest api allows you to build 3rd party applications that can interface with your Noopsi stuff.
Authentication
Every rest api request requires your api key. This key can be found in your general account settings.
A valid key should look something like this:
uusername9e1adf280f8e6896b1f130086
Base Url
This url is the base for all requests made to the Noopsi api:
http://noopsi.com/api/0.1
Return Formats
The only two return formats for the rest api are: TXT and JSON. A format must be specified using the format variable. If can get other formats like Atom or Rss by just using the normal feeds for every page.
Error Handling
If there is a problem with the request an appropriate HTTP status code will be returned along with an error message in the given return format.
Actions
get
Use this action to retrieve stuff from your account.
Base Url
This url is the base for all get requests:
http://noopsi.com/api/0.1/get/
Retrieving Activity Stream
base url:
http://noopsi.com/api/0.1/get/stream/
Variables
| Variable | Explanation |
| k | Required, must be set to your api key. |
| format | Required. see format for details. |
| limit | Optional. Set to default limit if not set. |
| page | Optional. The page number wanted. |
Examples
Get the last 40 entries/items you touched
http://noopsi.com/api/0.1/get/stream/?k=uusername9e1adf280f8e6896b1f130086&format=json&limit=40
Retrieving Search
base url:
http://noopsi.com/api/0.1/get/search/
Variables
| Variable | Explanation |
| k | Required, must be set to your api key. |
| q | Required. This should contain your search string. |
| format | Required. see format for details. |
| limit | Optional. Set to default limit if not set. |
| page | Optional. The page number wanted. |
Examples
Get the first 20 results matching, "Noopsi"
http://noopsi.com/api/0.1/get/search/?k=uusername9e1adf280f8e6896b1f130086&format=json&limit=20&q=Noopsi
Retrieving Deadlines
base url for getting upcoming entries/items:
http://noopsi.com/api/0.1/get/upcoming/
base url for getting entries/items on a specific date:
http://noopsi.com/api/0.1/get/date/
Retrieving dates can have year, month, and day:
http://noopsi.com/api/0.1/get/date/YEAR/MONTH/DAY/
Variables
| Variable | Explanation |
| k | Required, must be set to your api key. |
| format | Required. see format for details. |
| limit | Optional. Set to default limit if not set. |
| page | Optional. The page number wanted. |
Examples
Get the second page of upcoming results
http://noopsi.com/api/0.1/get/upcoming/?k=uusername9e1adf280f8e6896b1f130086&format=json&page=2
Get the entries/items with a deadline of today
http://noopsi.com/api/0.1/get/date/2013/5/22/?k=uusername9e1adf280f8e6896b1f130086&format=json&page=2
Retrieving Entries
base url:
http://noopsi.com/api/0.1/get/entry/
retrieving a specific entry, where ENTRY_ID is the numeric id of the entry:
http://noopsi.com/api/0.1/get/entry/ENTRY_ID/
Retrieving a specific type of entry, where ENTRY_TYPE is the name of the entry type (E.G., contact, list):
http://noopsi.com/api/0.1/get/entry/ENTRY_TYPE/
Variables
| Variable | Explanation |
| k | Required, must be set to your api key. |
| limit | Optional. Set to default limit if not set, only used if requesting multiple entries. |
| page | Optional. The page number of a multiple entry request. |
| format | Required. see format for details. |
Examples
Retrieve the first 20 contacts in json format
http://noopsi.com/api/0.1/get/entry/contact/?k=uusername9e1adf280f8e6896b1f130086&format=json&limit=20&page=1
Retrieve entry 43 in plain text format
http://noopsi.com/api/0.1/get/entry/43/?k=uusername9e1adf280f8e6896b1f130086&format=txt
Retrieving Items
base url:
http://noopsi.com/api/0.1/get/item/
retrieving a specific item, where ITEM_ID is the numeric id of the item:
http://noopsi.com/api/0.1/get/item/ITEM_ID/
Variables
| Variable | Explanation |
| k | Required, must be set to your api key. |
| format | Required. see format for details. |
| limit | Optional. Set to default limit if not set. |
| page | Optional. The page number wanted. |
Examples
Retrieve the second 20 items in json format
http://noopsi.com/api/0.1/get/item/?k=uusername9e1adf280f8e6896b1f130086&format=json&limit=20&page=2
Retrieve item 42 in plain text format
http://noopsi.com/api/0.1/get/item/42/?k=uusername9e1adf280f8e6896b1f130086&format=txt
set
All previous contents of an entry/item are replaced when using a set action. Set responds to both POST and GET requests. Set only works if you have a valid id for the entry/item.
base url:
http://noopsi.com/api/0.1/set/
Setting a specific entry, where ENTRY_ID is the numeric id of the entry:
http://noopsi.com/api/0.1/set/entry/ENTRY_ID/
Setting a specific item, where ITEM_ID is the numeric id of the item:
http://noopsi.com/api/0.1/set/item/ITEM_ID/
Variables
| Variable | Explanation |
| k | Required, must be set to your api key. |
| input | Required. Contains the new value of the entry/item. |
| format | Required. see format for details. |
Examples
Set Entry 43 with new input
http://noopsi.com/api/0.1/set/entry/43/?k=uusername9e1adf280f8e6896b1f130086&format=json&input=list+this+is+entry+43...
Set item 42 with new input
http://noopsi.com/api/0.1/set/item/42/?k=uusername9e1adf280f8e6896b1f130086&format=txt&input=-+this+is+item+42...
add
The add action can be used alone or on an entry to add items to the given entry. This is different than a set action in that if you give an entry, the previous contents of an entry will not be replaced.
base url:
http://noopsi.com/api/0.1/add/
Adding to a specific entry, where ENTRY_ID is the numeric id of the entry:
http://noopsi.com/api/0.1/add/entry/ENTRY_ID/
Variables
| Variable | Explanation |
| k | Required, must be set to your api key. |
| input | Required. Contains the new value of the entry/item. |
| format | Required. see format for details. |
Examples
Add input containing new items to entry 43
http://noopsi.com/api/0.1/add/entry/43/?k=uusername9e1adf280f8e6896b1f130086&format=json&input=-+this+item+will+be+added+to+entry+43
Add new input to your Noopsi account
http://noopsi.com/api/0.1/add/?k=uusername9e1adf280f8e6896b1f130086&format=txt&input=this+input+will+be+parsed+and+added+to+my+account
General Troubleshooting
If you get a bad request error, make sure all your key is correct and that all the correct variables are being sent to the server.
Set will replace all the contents of an entry with the new contents found in input. So if you just want to add some items to an entry, use add instead of set.
Xmlrpc API
Noopsi supports the Wordpress, MetaWeblog and Blogger xmlrpc APIs. This allows Noopsito interface with tons of applications that already support these specifications like Windows Live Writer, Microsoft Office, and the Wordpress iPhone Application.
Laconica/Twitter API
Base Url
This url is the base for all requests made to the Noopsi laconica api:
http://noopsi.com/api/
Noopsi has limited support for the Twitter/Laconica API.
Basically, Noopsi supports /statuses/friends_timeline, /statuses/update, and /statuses/destroy. Along with /account/verify_credentials. You can request responses with either json or xml. This limited support allows you to post and view your Noopsi entries/items, as well as add and delete them, in a Laconica client like Twhirl.