discord-bots/TheArtificer
discord-bots
/
TheArtificer
mirror of https://github.com/Burn-E99/TheArtificer.git
1
1
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

API docs update

This commit is contained in:
Ean Milligan 2025-07-23 01:25:24 -04:00
parent f704cd9fa0
commit 799efd38f3
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/API.md
View File

@ -1,5 +1,5 @@
## The Artificer API
The Artificer features an API that allows authenticated users to roll dice into Discord from third party applications (such as Excel macros). The API has a couple endpoints exposed to all authenticated users allowing management of channels that your API key can send rolls to. APIs requiring administrative access are not listed below.
The Artificer features an API that allows authenticated users to roll dice into Discord from third party applications (such as Excel macros). The API has a couple endpoints exposed to all authenticated users allowing management of channels that your API key can send rolls to.
Guilds Owners or Admins must run the `[[api allow` command for any users to be able to use the `/api/roll` endpoint.
@ -14,6 +14,6 @@ Every API request **requires** the header `X-Api-Key` with the value set to the
Official API URL: `https://artificer.eanm.dev/api/`
API Documentation can be found in the `.bruno` folder, which can be viewed in [Bruno](https://www.usebruno.com/).
API Documentation can be found in the `.bruno` folder, which can be viewed in [Bruno](https://www.usebruno.com/). API requests listed in the `Authenticated/Admin Requests` are only available to the admin user defined in `config.ts`.
API Key management via a basic GUI is available on the [API Tools](https://artificer.eanm.dev/) website.