eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-08 14:57:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(api, docs): send HTTP 400 on empty User-Agent, update docs

Browse source
This commit is contained in:
Iris System 2023-02-27 09:34:48 +13:00
parent b2c61e3e8e
commit 5e60dec6ec
3 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/content/api/reference.md
View file

@ -21,7 +21,14 @@ For models that have them, the keys `id`, `uuid` and `created` are **not** user-
Endpoints taking JSON bodies (eg. most `PATCH` and `PUT` endpoints) require the `Content-Type: application/json` header set.
## User agent
The API requires the `User-Agent` header to be set to a non-empty string. Not doing so will return a `400 Bad Request` with a JSON body.
If you are developing an application exposed to the public, we would appreciate if your `User-Agent` uniquely identifies your application, and (if possible) provides some contact information for the developers - so that we are able to contact you if we notice your application doing something it shouldn't.
## Authentication
Authentication is done with a simple "system token". You can get your system token by running `pk;token` using the
Discord bot, either in a channel with the bot or in DMs. Then, pass this token in the `Authorization` HTTP header
on requests that require it. Failure to do so on endpoints that require authentication will return a `401 Unauthorized`.