There are currently two existing open-source server implementations of the Bitcache REST API: one, bitcached, is written in Ruby and is included in the Bitcache reference implementation; the other is written in PHP and available as an add-on module for the Drupal content management framework.
Note that the question of authentication is entirely orthogonal to this API; authentication would typically be implemented using standard HTTP methods, but a cookie-based session, or indeed a publicly-available repository, is equally compatible with the REST API.
| Method | Purpose |
|---|---|
OPTIONS / |
Discover set of valid HTTP methods for the bitstream index. |
OPTIONS /<id> |
Discover set of valid HTTP methods for a bitstream resource. |
INDEX / |
Retrieve full index of available bitstreams. |
INDEX /<str> |
Retrieve partial index of bitstreams based on <str>. |
GET / |
Equivalent to INDEX /. |
GET /<id> |
Download bitstream identified by <id>. |
HEAD / |
Like GET / but omit the response body. |
HEAD /<id> |
Like GET /<id> but omit the response body. |
POST / |
Upload bitstream. |
PUT /<id> |
Upload bitstream, with <id> verification. |
DELETE /<id> |
Delete bitstream identified by <id>. |