asdasd
This commit is contained in:
29
custom/apps/fx-rates/docs/README.md
Normal file
29
custom/apps/fx-rates/docs/README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Waehrungs-Checker Modul
|
||||
|
||||
Das Modul `fx-rates` stellt gespeicherte Waehrungskurse, Historie, Umrechnung und manuelle Refresh-Aktionen bereit.
|
||||
|
||||
## Kernpunkte
|
||||
|
||||
- Desktop-App unter `custom/apps/fx-rates/desktop.php`
|
||||
- API unter `/api/fx-rates/...`
|
||||
- Widget fuer den rechten Desktop-Infobereich ueber `config/widgets.php`
|
||||
- externer Provider-Token wird aus dem alten Bestand als Default uebernommen
|
||||
- oeffentliche Einstiege laufen ueber `public/apps/fx-rates/index.php` und `public/api/fx-rates/index.php`
|
||||
|
||||
## Refresh-Regeln
|
||||
|
||||
- das Oeffnen der App loest keinen externen Abruf aus
|
||||
- `POST /api/fx-rates/.../refresh` aktualisiert nur, wenn der letzte Snapshot aelter als die konfigurierte Sperrzeit ist
|
||||
- mit `force=true` kann ein Abruf explizit erzwungen werden
|
||||
- das Desktop-Widget nutzt dieselbe Logik
|
||||
|
||||
## API
|
||||
|
||||
Wichtige Endpunkte:
|
||||
|
||||
- `GET /api/fx-rates/v1/latest`
|
||||
- `GET /api/fx-rates/v1/rate`
|
||||
- `GET /api/fx-rates/v1/history`
|
||||
- `POST /api/fx-rates/v1/refresh`
|
||||
- `GET /api/fx-rates/v1/settings`
|
||||
- `PUT /api/fx-rates/v1/settings`
|
||||
Reference in New Issue
Block a user