e1b51db4df
Update everything (I may have forgotten a few details however) Split installation documentation in many parts, and make it so that you only read what you need to read. Left menu to quickly go to another page. Remove the i18n docs as it was outdated and it duplicated contribute.joinplu.me
1.5 KiB
1.5 KiB
| title | icon | summary |
|---|---|---|
| API documentation | code | 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:
client_id, your client ID.client_secret, your client secret.scopes, the scopes you want to access. They are separated by+, and can either beread(global read),write(global write),read:SCOPE(read only inSCOPE), orwrite:SCOPE(write only inSCOPE).usernamethe username (not the email, display name nor the fully qualified name) of the user using your app.password, the password of the user.
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>