API
Common information
HTTP Status
- 201 Created - Database or item was successfully created.
- 200 OK - No error.
- 403 Forbidden - API key is wrong or editing database created by other user.
- 400 Bad Request - Request parameter is invalid.
Database
Get
- HTTP Method
- GET
- URL
-
/databases.json (All Databases)
/databases/:database_name.json - parameter
-
- page - If this parameter is given, display 50 items per page. If this parameter is not given, display all items.
Create
Creates new database. Returns "201 Created" and new database url in location header when successful.
- HTTP Method
- POST
- URL
- /databases
- parameter
-
- api_key - required
- database[name] - required - Cannot include "."(dot) and "/"(slash), cannot be number only, and must be unique.
- database[description] - A description of the database.
- database[required_keys] - required - Database's required keys. If you want to set multiple keys, please set space separated value.
- database[optional_keys] - Database's optinal keys. If you want to set multiple keys, please set space separated value.
- database[permit_other_keys] - Whether or not you permit to add keys ohter than required keys and optional keys. If this parameter is not given, this value set false.
Update
Updates database configuration. Returns "200 OK" when successful.
- HTTP Method
- PUT
- URL
- /databases/:database_name
- parameter
-
- api_key - required
- database[name] - existing database name
- database[description] - A description of the database.
- database[required_keys] - required - Database's required keys. If you want to set multiple keys, please set space separated value.
- database[optional_keys] - Database's optinal keys. If you want to set multiple keys, please set space separated value.
- database[permit_other_keys] - Whether or not you permit to add keys ohter than required keys and optional keys. If this parameter is not given, this value set false.
Delete
Deletes database. Returns "200 OK" when successful.
- HTTP Method
- DELETE
- URL
- /databases/:database_name
- parameter
-
- api_key - required
Item
Get
- HTTP Method
- GET
- URL
-
/databases/:database_name/items.json (all items)
/items/:item_id.json - parameter
-
- page - If this parameter is given, display 50 items per page. If this parameter is not given, display all items.
Create
Creates new item. Returns "201 Created" and new item url in location header when successful.
- HTTP Method
- POST
- URL
- /databases/:database_name/items
- parameter
-
- api_key - required
- name - Items name. if this parameter is not given, random string is set.
- data[key] - Updates item's value.
Update
Updates item's value. Returns "200 OK" when successful.
- HTTP Method
- PUT
- URL
- /items/:item_id
- parameter
-
- api_key - required
- data[key] - Updates item's value.
Delete
Deletes item. Returns "200 OK" when successful.
- HTTP Method
- DELETE
- URL
- /items/:item_id
- parameter
-
- api_key - required