VANA/VANA-php/README.md

20 lines
1.0 KiB
Markdown
Raw Normal View History

2024-10-11 08:02:45 +02:00
# VANA Projekt
## Inbetriebnahme
Die Applikation basiert auf dem PHP-Framework [Laravel (V11)](https://laravel.com/docs/11.x/installation).
Die folgenden Beschreibungen beziehen sich auf die im Rahmen des Moduls erarbeitete Bestandteile.
## SRG Endpoints
Die Applikation aggregiert Daten von den APIs [SRGSSR Video](https://developer.srgssr.ch/api-catalog/srgssr-video) und [SRGSSR Play Subtitles](https://developer.srgssr.ch/api-catalog/srgssr-play-subtitles). Um die APIs verwenden zu können ist die Registrierung eines Accounts im [SRG-SSR Developer Portal](https://developer.srgssr.ch/api-catalog/srgssr-play-subtitles) nötig und entsprechende Apps müssen registriert werden. Pro App wird ein Consumer Key und Consumer Secret erstellt. Diese können der Datenbank über den folgenden Befehl hinzugefügt werden.
```bash
artisan app:add-endpoint {endpoint} {key:value;key:value}
```
fiktives Beispiel:
```bash
artisan app:add-endpoint https://api.srgssr.ch/videometadata/v2/ "key:AbC123def456GhI789JklmnOpQrstuVw;secret:987zyx654wvu3210"
```