API v1

I (Dennis Schubert, @denschub) am working at this document right now. Please wait until I’ve fully inserted my drafts – should be done until the end of the day. :-)

The Diaspora API – Version 1

This is a draft for designing Diaspora’s API version 1. This is neither complete nor correct, it’s just a collection of ideas.

General notes

We want to use as much already existing standards as possible, so we decided to use JSON Activity Streams for everything related with streams and messages and Portable Contacts for everything regarding profiles.

Authentication

In this first version we are going to use http basic auth until OAuth is fully implemented and tested. Devise supports http basic auth and that’s easy to enable.

Stream

GET /stream

Returns a JSON of the stream items.

Parameters

no parameters

Example

GET /contacts
{
  "contacts": [
    {
      "id": "23",
      "displayName": "John Doe"
    },
    {
      "id": "42",
      "displayName": "Jane Doe"
    }
  ]
}