Developers Beta

TextShelf's file formats and its API, for anyone building software that reads or writes a reviewer's work.

File formats

The web service and the TextShelf app for Mac exchange a reviewer's work as plain JSON files, and the app keeps each shelf as a folder of JSON and PDF files. Each format is specified, with an example file and, for the exchanged ones, a JSON Schema.

• Overview and the rules every format follows
• Review packet: a reviewer's assigned entries and review form, from the web to the Mac app
• Review return: the reviewer's scores, from the Mac app back to the web
• Review inbox: the web reviewers' scores, for reading beside your own on a Mac
• Shelf bundle: the .textshelf folder the Mac app saves
• Workspace packs: the starting rubric for each kind of shelf

This specification is licensed under CC BY 4.0, and its example and schema files under the MIT licence. Anyone may implement these formats in their own software.

API

A script or an agent can act as you over a small JSON API with an access token. How to get a token, and what answers.