REST API Reference

This API uses the standard Collection+JSON hypermedia type to exchange resource representations with clients. All the functionality provided by the API can be discovered by clients by doing GET requests to links (“href” elements) presented by the hypermedia documents returned by the web server, starting with the API’s “home page”.

The API’s “home page” relative url is: /api/v1/ which serves a user-specific collection of feeds.

There are two main types of resources served by the API:

Collection

A resource to group other resources together. Its representation focuses on links to other resources, though it may also include snippets from the representations of those other resources.

Item

A standalone resource that is linked to from a collection’s representation.

The following table shows the API’s HTTP protocol semantics for these resource types:

API’s accepted HTTP requests

Collection resource		Item resource
read-only	read/write	read-only	read/write
GET	GET POST	GET	GET PUT DELETE

Following are the actuall lists of resource types:

Collections:

• Feed collection
• Comment collection
• Tag collection
• File collection
• Plugin collection
• Plugin Parameter collection
• Plugin Instance collection
• User collection

Items:

• Feed item
• Comment item
• Tag item
• File item
• Plugin item
• Plugin Parameter item
• Plugin Instance item
• User item

Other resources:

• Note
• File content
• String Parameter instance
• Integer Parameter instance
• Float Parameter instance
• Boolean Parameter instance
• Path Parameter instance