Zwei Tracks: in unter fünfzehn Minuten von null zu live.
Track 1 bringt Sie von einem frischen Konto zum ersten API-Aufruf. Track 2 bringt Sie vom offiziellen App-Skeleton zur veröffentlichten App auf einem Screen. Wählen Sie den passenden Track.
Track 1: Erster API-Aufruf
Track 2: Erste veröffentlichte App
Voraussetzungen
Ein ScreenWay-Konto
studio.screenway.com. Owner- oder Konto-Mitglied-Rolle reicht für beide Tracks.Eine Shell mit curl
requests.Track 1 · Erster API-Aufruf
Ziel: ein erfolgreicher GET /api/v1/screens-Request und eine Notification an alle Screens, die der Key erreichen darf.
1. API-Key anlegen
- Öffnen Sie
Einstellungen → API Keysim Studio. - Klicken Sie „API-Key anlegen“, vergeben Sie einen klaren Namen und einen Scope.
- Kopieren Sie den
swk_…-Token sofort. Er wird nur einmal angezeigt.
Keys wie Passwörter behandeln
2. Env-Variable setzen
So bleibt der Token aus Shell-History und Git fern.
# Den nach dem Anlegen einmalig angezeigten Key einsetzen
export SCREENWAY_API_KEY=swk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3. Ersten Aufruf machen
Wählen Sie die Sprache, die Sie ohnehin nutzen. Alle drei Beispiele rufen denselben Endpoint auf und geben eine kurze Konto-Übersicht aus.
curl https://studio.screenway.com/api/v1/screens \
-H "Authorization: Bearer $SCREENWAY_API_KEY"Erwartete Antwort
200-Antwort enthält ein data-Array mit Screens und ein meta-Objekt mit Pagination. Leere Konten liefern ein leeres Array, das ist normal.4. Notification senden
Notifications sind die sicherste Schreiboperation zum Einstieg: kein persistenter Status, sofort sichtbares Feedback auf jedem Online-Screen.
curl -X POST https://studio.screenway.com/api/v1/notifications \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $SCREENWAY_API_KEY" \
-d '{
"title": "Hallo von der API",
"message": "Erster Request funktioniert.",
"category": "INFO",
"priority": "NORMAL",
"duration_seconds": 15
}'- Notifications ohne explizites targets-Array nutzen den Key-Scope
- Ein 403 heißt: Ihre Targets liegen außerhalb des Key-Scope. Request verengen oder Key erweitern
- Ein 404 mit „No screens found" bedeutet: kein Online-Screen erreichbar
- action_url und action_label ermöglichen einen Tap-Through-CTA auf Touch-Kiosken
Track 2 · App veröffentlichen
Ziel: das offizielle Skeleton nehmen, mit Ihrer Marke versehen, lokal testen, paketieren und in Studio als neue App hochladen.
1. Skeleton laden
Das Skeleton enthält bereits Universal App Scaler, eine via postMessage verdrahtete config.html, deutsche und englische Locales und das Safe-Default-Boot-Pattern. Nutzen Sie es; das spart Stunden Plumbing.
# In einem leeren Ordner
unzip ~/Downloads/app-skeleton.zip -d my-first-app
cd my-first-app2. Umbenennen und konfigurieren
In app.json einen stabilen slug wählen, version auf 1.0.0 setzen und die Config-Felder definieren, die Nutzer später im Studio bearbeiten.
{
"name": "Lobby Welcome",
"slug": "lobby-welcome",
"version": "1.0.0",
"category": "utility",
"is_free": true,
"config_schema": {
"fields": [
{ "key": "title", "type": "text", "default": "Willkommen", "required": true }
]
}
}Alle sichtbaren Texte in locales/de.json verschieben. Deutsch ist der universelle Fallback; jede andere Locale fällt für fehlende Schlüssel darauf zurück.
{
"description": "Freundliche Begrüßungsanzeige für Eingangsbereiche.",
"featured": {
"title": "Ein warmer Gruß auf jedem Bildschirm",
"description": "Editierbarer Titel, transparenter Overlay, in Minuten einsatzbereit."
},
"config_schema": {
"fields": {
"title": { "label": "Headline" }
}
},
"runtime": {
"fallback": { "title": "Willkommen", "subtitle": "In den App-Einstellungen konfigurieren." }
}
}Slug ist endgültig
3. Lokal testen
Beliebigen statischen File-Server im App-Ordner starten. Ohne Studio-iFrame nutzt das Skeleton seine Inline-Defaults, und Ihre URL-Parameter überschreiben sie.
python3 -m http.server 8000
# Runtime: http://localhost:8000/
# Settings-Formular: http://localhost:8000/config.html
# URL-Parameter überschreiben Defaults: ?title=Hi&fontSize=180- index.html rendert die Runtime-UI
- config.html rendert das Settings-Formular (Studio rahmt es normalerweise in einem iFrame)
- URL-Parameter ändern die Config ohne Rebuild
- window.APP_CONFIG ist im Standalone-Modus undefined (genau so geplant)
4. Paketieren und einreichen
version in app.json bumpen, banner.png (1200×400) und featured.png (1920×1080) ins Bundle-Root legen, dann ein flaches ZIP aus dem App-Ordner heraus packen.
# Aus dem App-Ordner heraus. build.sh liegt im Skeleton
cd my-first-app
./build.sh --bump-patch
# → my-first-app-v1.0.1.zip im aktuellen VerzeichnisZIP an apps@screenway.com senden, mit App-Slug, Ziel-Locales und einem Einzeiler zur Änderung. Das ScreenWay-Team validiert das Bundle, lädt es in den Katalog und antwortet mit dem Live-Link.
Self-Service-Uploads sind in Planung