Skip to content
Andreas Gohr edited this page Jan 29, 2018 · 14 revisions

In general all API requests require a Bearer Authentication token which is send as a header in every request. The authenticatio API endpoint handles the creation and refreshing this token.

Registering a Device

To talk to the API a new device (this can be a tablet or a desktop or mobile client) has to be registered through an 8 letter code. This generates a new Bearer Authentication token.

Send the POST request with an empty 'Authentication: Bearer' header.

POST https://my.remarkable.com/token/device/new

Payload:

{
    "code": "gliuqtne",
    "deviceDesc": "desktop-windows",
    "deviceID": "701c3752-1025-4770-af43-5ddcfa4dabb2"
}
  • code is the code generated at https://my.remarkable.com/generator-device
  • deviceDesc describes he type of the device can be one of desktop-windows, FIXME what else?
  • deviceID a UUID-4, simply generate a new one to identify your client

The response is the new token in plain text.

Refreshing a Token

Bearer Tokens should be refreshed before using. I haven't seen them expiring so far, but that might happen in the future.

Simply send a GET request with the current token as 'Authentication: Bearer ' header.

GET https://my.remarkable.com/token/user/new

The response is the new token in plain text.

Deregistering a Device (aka. logout)

FIXME haven't figured this out, yet

Clone this wiki locally