Matthias-Claudius-Schule/borrow-system
4
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update API documentation to clarify API key requirements

Browse Source
This commit is contained in:
Theis Gaedigk
2025-11-11 21:08:10 +01:00
parent 17010d5480
commit 6f03fd8032
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Docs/backend_API_docs/README.md
View File

@@ -30,6 +30,10 @@ _I have also build a [fallback page](https://git.the1s.de/theis.gaedigk/fallback
All endpoints require an API key as a path parameter named `:key`. All endpoints require an API key as a path parameter named `:key`.
**The API key must be always 15 characters long and can only contain numbers.**
You can get the API key from the admin dashboard.
Example: `/api/items/:key` Example: `/api/items/:key`
If the key is missing or invalid, the API responds with `401 Unauthorized`. If the key is missing or invalid, the API responds with `401 Unauthorized`.