diff options
| author | Wim Vanderbauwhede <wim.vanderbauwhede@mail.be> | 2019-02-14 16:41:40 +0000 |
|---|---|---|
| committer | Wim Vanderbauwhede <wim.vanderbauwhede@mail.be> | 2019-02-14 16:41:40 +0000 |
| commit | 04b1c135543965860029557fc216eb38fd63b6c7 (patch) | |
| tree | c1fb60376eeb35539704c23d282af7777895d4ea /docs/Pleroma-API.md | |
| parent | bf5b1c7f06c9f8882c40cf2385439bee3b74522c (diff) | |
| parent | 1d17082ab2523eb75ee0ca4a49e45da0d0edabd7 (diff) | |
| download | pleroma-04b1c135543965860029557fc216eb38fd63b6c7.tar.gz pleroma-04b1c135543965860029557fc216eb38fd63b6c7.zip | |
Merge remote-tracking branch 'upstream/develop' into patch-image-description
Diffstat (limited to 'docs/Pleroma-API.md')
| -rw-r--r-- | docs/Pleroma-API.md | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/docs/Pleroma-API.md b/docs/Pleroma-API.md index da58babf9..e1448d3f0 100644 --- a/docs/Pleroma-API.md +++ b/docs/Pleroma-API.md @@ -1,13 +1,9 @@ -# Authentication +# Pleroma API Requests that require it can be authenticated with [an OAuth token](https://tools.ietf.org/html/rfc6749), the `_pleroma_key` cookie, or [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization). -# Request parameters - Request parameters can be passed via [query strings](https://en.wikipedia.org/wiki/Query_string) or as [form data](https://www.w3.org/TR/html401/interact/forms.html). Files must be uploaded as `multipart/form-data`. -# Endpoints - ## `/api/pleroma/emoji` ### Lists the custom emoji on that server. * Method: `GET` @@ -15,6 +11,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi * Params: none * Response: JSON * Example response: `{"kalsarikannit_f":"/finmoji/128px/kalsarikannit_f-128.png","perkele":"/finmoji/128px/perkele-128.png","blobdab":"/emoji/blobdab.png","happiness":"/finmoji/128px/happiness-128.png"}` +* Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format ## `/api/pleroma/follow_import` ### Imports your follows, for example from a Mastodon CSV file. @@ -55,6 +52,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi * `confirm` * `captcha_solution`: optional, contains provider-specific captcha solution, * `captcha_token`: optional, contains provider-specific captcha token + * `token`: invite token required when the registerations aren't public. * Response: JSON. Returns a user object on success, otherwise returns `{"error": "error_msg"}` * Example response: ``` |