Herzen, Reichweite und App-Anbindung (0.30.0)
Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 6m10s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Failing after 6m3s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 7m33s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 7m25s
CI / PHP 8.3 / mysql:8.0 (pull_request) Failing after 7m28s
CI / PHP 8.4 / mysql:8.0 (pull_request) Failing after 7m27s
CI / PHP 8.3 / mysql:8.4 (pull_request) Failing after 6m26s
CI / PHP 8.4 / mysql:8.4 (pull_request) Failing after 6m27s
CI / Bekannte Sicherheitslücken in Paketen (pull_request) Successful in 44s
CI / Build-Artefakte aktuell (pull_request) Successful in 1m12s
Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 6m10s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Failing after 6m3s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 7m33s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 7m25s
CI / PHP 8.3 / mysql:8.0 (pull_request) Failing after 7m28s
CI / PHP 8.4 / mysql:8.0 (pull_request) Failing after 7m27s
CI / PHP 8.3 / mysql:8.4 (pull_request) Failing after 6m26s
CI / PHP 8.4 / mysql:8.4 (pull_request) Failing after 6m27s
CI / Bekannte Sicherheitslücken in Paketen (pull_request) Successful in 44s
CI / Build-Artefakte aktuell (pull_request) Successful in 1m12s
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
d9fcc7a9b4
commit
b3e2b525e1
161 changed files with 1249 additions and 342 deletions
24
docs/API.md
24
docs/API.md
|
|
@ -20,7 +20,17 @@ Ein Token bekommt man auf zwei Wegen:
|
|||
{ "email": "ada@example.org", "password": "…", "device_name": "iPhone von Ada" }
|
||||
```
|
||||
Antwort `201`: `{ "token": "1|…", "user": { … } }`. Höchstens 10 Versuche je Minute.
|
||||
2. **Im Portal** unter *Profil bearbeiten → Benachrichtigungen & Apps → Zugang*. Der Weg für
|
||||
2. **Über den Browser** (Inhaus-App, klappt mit jedem Anmeldedienst) – Ablauf wie OAuth mit PKCE:
|
||||
1. Die App erzeugt einen geheimen `code_verifier` (43–128 Zeichen) und daraus
|
||||
`code_challenge = base64url(sha256(code_verifier))` ohne `=`, dazu einen zufälligen `state`.
|
||||
2. Sie öffnet `https://<portal>/app/verbinden?redirect_uri=inhaus://verbunden&device_name=…&code_challenge=…&state=…`
|
||||
im Browser. Die Person meldet sich an und bestätigt.
|
||||
3. Das Portal leitet zurück an `inhaus://verbunden?code=…&state=…`. Der Code gilt 5 Minuten und nur einmal.
|
||||
4. `POST /token/exchange` mit `{ "code": "…", "code_verifier": "…" }` → `201` wie bei `POST /token`.
|
||||
|
||||
Erlaubt sind nur Rücksprung-Adressen mit dem Schema `inhaus://`. Für die Entwicklung mit Expo Go
|
||||
zusätzlich `INHAUS_APP_SCHEMES=inhaus,exp` in der `.env` setzen.
|
||||
3. **Im Portal** unter *Profil bearbeiten → Benachrichtigungen & Apps → Zugang*. Der Weg für
|
||||
alle, die sich über Microsoft, LDAP oder SAML anmelden (sie haben kein Portal-Passwort).
|
||||
Der Schlüssel wird nur einmal angezeigt.
|
||||
|
||||
|
|
@ -31,6 +41,7 @@ Tokens deaktivierter Konten gelten sofort nicht mehr.
|
|||
|
||||
| Methode | Pfad | Inhalt |
|
||||
|---|---|---|
|
||||
| GET | `/config` | ohne Anmeldung: Name, Hausfarbe, Logo, Symbol, Anmeldewege, `connect_url` |
|
||||
| GET | `/me` | eigenes Profil, Anzahl ungelesener Benachrichtigungen |
|
||||
| GET | `/notifications` | Benachrichtigungen (30 je Seite, `?page=`), `meta.unread` |
|
||||
| POST | `/notifications/{id}/read` | eine als gelesen markieren |
|
||||
|
|
@ -39,7 +50,10 @@ Tokens deaktivierter Konten gelten sofort nicht mehr.
|
|||
| GET | `/people/{id}` | Kontaktdaten und freigegebene Profilfelder |
|
||||
| GET | `/search?q=` | globale Suche (wie die Suche oben im Portal) |
|
||||
| GET | `/news?category=` | Neuigkeiten (20 je Seite) |
|
||||
| GET | `/news/{slug}` | Beitrag mit Inhalt als Blöcke (`blocks`) und reinem Text (`text`) |
|
||||
| GET | `/news/{slug}` | Beitrag mit Inhalt als Blöcke (`blocks`) und reinem Text (`text`); `likes`, `liked` |
|
||||
| POST/DELETE | `/news/{slug}/like` | Herz geben bzw. zurücknehmen → `{ data: { liked, likes } }` |
|
||||
| POST | `/push/devices` | App-Gerät für Push anmelden: `{ "token": "ExponentPushToken[…]", "platform": "ios", "name": "…" }` |
|
||||
| DELETE | `/push/devices` | App-Gerät abmelden: `{ "token": "…" }` |
|
||||
| GET | `/events` | anstehende Termine |
|
||||
| GET | `/events/{id}` | Termin mit Beschreibung (HTML) und Kalenderdatei (`ics_url`) |
|
||||
|
||||
|
|
@ -69,5 +83,7 @@ wenn das Portal zum Home-Bildschirm hinzugefügt ist) schaltet jede Person Push
|
|||
Technisch: Web-Push mit VAPID (RFC 8291/8292), Schlüssel entstehen automatisch, der Versand läuft
|
||||
über die Warteschlange (Cron nötig). Voraussetzung ist HTTPS.
|
||||
|
||||
Native Apps (App Store, Google Play) können die API nutzen; Push für native Apps
|
||||
(Apple/Google-Dienste) ist noch nicht angebunden.
|
||||
Die Inhaus-App (App Store, Google Play) meldet ihr Gerät mit `POST /push/devices` an. Der Versand
|
||||
läuft über den Push-Dienst von Expo, der an Apple und Google weiterleitet; übertragen werden Titel,
|
||||
Kurztext und Link (`data.url`, ein Pfad im Portal). Abgemeldete Geräte entfernt das Portal selbst.
|
||||
Wird ein App-Zugang entzogen, fällt auch das Gerät weg.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue