Editor Interface

Jump to bottom Edit New page

Martin Stoffers edited this page Nov 5, 2015 · 1 revision

All api-communication (creating new documents, transfer document content, ...) is done via a HTTPS-API. Note that SSL is mandatory.
The user-communication (editing documents) is handled directly by the editor. Sessions are handled by OAuth.

{
  "type": "etherpad", // linked to a class
  "nickname": "ep",   // used as DB-key for documents
  "humanName": "Etherpad", // displayed in dropdown-boxes and so on
  "secret": "",
  "userurl": "https://ep.shownot.es/p/",
  "apiurl": "https://ep.shownot.es/sapi/"
}

HTTP-API

All requests must have the secret in the X-SNOTES-SECRET-header.

Endpoints

/document
- Supported: GET POST DELETE

User sessions

todo