Connections - readmill/API GitHub Wiki

This is the documentation for v1 of the Readmill API which is deprecated and will be discontinued on 2012-12-16. Please upgrade to v2, the new developer documentations are at developers.readmill.com.

Connections

This part of the API has to do with reading the state of service connections. Service connections represent links to other networks that the user has created, ex. Twitter or Facebook.

Available endpoints

  • /me/connections, GET
  • /me/connections/#{id}, GET

Representation

An example of the JSON representation of a connection to twitter could look like below,

{
  "id": 40,
  "service": "twitter",
  "post_highlight": false,
  "post_reading": false
}

The post fields refer to if posting on that kind of event should be default or not. If post_to is omitted on the following endpoints the default action will be performed.

  • POST /books/#{id}/readings uses post_reading (ex. start reading)
  • POST /readings/#{id}/highlights uses post_highlight (ex. highlighted)
  • PUT /readings/#{id} uses post_reading (ex. finished reading)

They refer to the settings set at http://readmill.com/settings/connections.

API Calls

GET /me/connections

Get all connections for the current user.

The default sort order is service ascending.

Authentication

  • access_token

Response

  • 200 and a list of connections

Examples

curl http://api.readmill.com/me/connections?access_token=TOKEN

GET /me/connections/#{id}

Retrieves the representation of a single connection.

Parameters

  • id: The id of the connection.

Authentication

  • access_token

Response

  • Success: 200 and a connection
  • Failure: 404

Examples

curl http://api.readmill.com/me/connections/40?access_token=TOKEN