Merge branch 'document-api-auth' into 'develop'

document API authentication

See merge request !1145

README.md

@@ -39,6 +39,7 @@ Prodinstanz: <https://api.events.ccc.de/congress/2024/>
 
 | Kategorie  | Endpunkt                                 | GET | POST | PUT | DEL | Beschreibung                                          |
 | ---------- | ---------------------------------------- | --- | ---- | --- | --- | ----------------------------------------------------- |
+| Auth       | `/auth/get-token`                        |     | x    |     |     | Ausstellen eines API-Tokens                           |
 | Persönlich | `/me`                                    | x   |      | x   |     | eigenes Profil / Settings                             |
 | Persönlich | `/me/friends`                            | x   |      | x   | x   | Liste der Buddies                                     |
 | Persönlich | `/me/badges`                             | x   |      |     |     | Liste aller Badges/Achievements                       |
@@ -64,6 +65,20 @@ Prodinstanz: <https://api.events.ccc.de/congress/2024/>
 Per POST werden neue Einträge angelegt, per PUT bestehende verändert.
 Details zu den einzelnen Endpunkten folgen in Kürze™.
 
+### API-Beispiel mit cURL
+
+Zuerst einen Token generieren:
+
+```bash
+curl https://{API_URL}/api/auth/get-token -H "Content-Type: application/json" -X POST --data '{"username": "{USERNAME}", "passwort": "{PASSWORD}"}'
+```
+
+Mit diesem Token können dann Endpunkte aufgerufen werden die eine Authentifizierung erfordern:
+
+```bash
+curl https://{API_URL}/api/me -H "Content-Type: application/json" -H "Authorization: Token {API_TOKEN}"
+```
+
 ## Development
 
 see [Development.md](./Development.md)