Access Keys
Access keys allow non-collaborator to access a private book. Each access key can be converted to an unique read-only access url.
Create an access key
Create a new book for the specified author.
POST /book/:author/:book/keys
Parameters
| Name | Type | Description |
|---|---|---|
label |
string | Required: Label to identify the key |
key |
string | Optional value of the key, if not provided it'll be set as a random string |
List access keys for a book
GET /book/:author/:book/keys/
Example Response
{
"list": [
{
"id": "564c97a917c24e09ddd8b765",
"label": "For Aaron",
"key": "aaron_private_key",
"active": true,
"dates": {
"created": "2015-11-19T12:22:27.765Z",
"updated": "2015-11-19T12:22:27.765Z"
}
}
...
],
"total": 15,
"limit": 10,
"page": 0
}