API documentation

Plume can be extended by other applications thanks to a REST API.

Getting an API token

To get access to the API, you should register your app and obtain a token. To do so, use the /api/v1/apps API (accessible without a token) to create a new app. Store the result somewhere for future use.

Then send a request to /api/v1/oauth2, with the following GET parameters:

Plume will respond with something similar to:

  "token": "<YOUR TOKEN HERE>"

To authenticate your requests you should put this token in the Authorization header:

Authorization: Bearer <YOUR TOKEN HERE>