indiebookclub
Sign In

Documentation

Micropub Requests

The Micropub JSON syntax is used when indiebookclub posts to your endpoint.

Example:

{
  "type": ["h-entry"],
  "properties": {
    "summary": ["Want to read: Title by Author, ISBN: ISBN"],
    "read-status": ["to-read"],
    "read-of": [
      {
        "type": ["h-cite"],
        "properties": {
          "name": ["Title"],
          "author": ["Author"],
          "uid": ["isbn:ISBN"]
        }
      }
    ],
    "visibility": ["public"]
  }
}

read-status will be “to-read”, “reading”, or “finished” based on your selection.

uid will have a scheme of either isbn: or doi: based on your selection

author and uid properties will only be included if you enter those fields.

visibility will be “public”, “private”, or “unlisted” based on your selection. The private and unlisted options are only available if your Micropub endpoint indicates it supports them.

Query Parameters

The new post form accepts URL query parameters to pre-populate fields. This can be used with bookmarklets to make adding new posts easier.

Parameters

Any combination of these parameters can be used.

  • read-status: Values “to-read”, “reading”, or “finished” (not case-sensitive)
  • title
  • authors
  • isbn
  • doi
  • tags

Consuming read posts

You can provide a URL in the read-of parameter. If indiebookclub finds a read-of microformat at that URL, it will pre-populate the form with that information. If no read-of property is found, it will check for an h-cite microformat.

Note that if the read-of query parameter is provided, it takes precedence over the other parameters listed above.

Export Posts

The Settings page has a button to download an HTML+microformats export of your posts.