Apps für NemDisplay entwickeln Neu
Erstellen Sie eine App in HTML, CSS und JavaScript, die die Kunden von NemDisplay als Slide in der Playlist auf ihre Bildschirme bringen können.
Was Sie bauen können
Apps, die Daten aus Ihren eigenen Systemen oder denen Ihrer Kunden auf dem Bildschirm zeigen, etwa das heutige Menü aus dem Kantinensystem, die heutigen Buchungen oder die Wartezeit in einer Warteschlange.
Läuft in einer Sandbox
Jede App läuft in ihrem eigenen Sandbox-iframe auf dem Player mit einer strengen CSP. Sie hat keinen Zugriff auf den Player, andere Apps oder das Netzwerk.
Daten über NemDisplay
Der Daten-Proxy von NemDisplay holt die Daten von der Adresse im Manifest und sendet nur das Ergebnis an den Bildschirm. API-Schlüssel bleiben auf dem Server und erreichen nie den Bildschirm.
Offline auf der Box
Die Dateien der App und die neuesten Daten werden auf dem Player gespeichert, wie Bilder und Videos. Fällt das Netzwerk aus, läuft die App mit den zuletzt erhaltenen Daten weiter.
Jedes Bildschirmformat
Bildschirme im Quer- und Hochformat sowie Zonen in einem Layout. Die App erhält ihre Größe vom Player und skaliert mit der Typografie von NemDisplay.
So funktioniert es
- App bauen. Eine App ist ein Ordner mit
manifest.json, HTML, CSS, JavaScript und Übersetzungen. Testen Sie sie im Emulator mitnd-app dev. - Version hochladen.
nd-app publishvalidiert, packt und lädt die App als Entwurf hoch. Die ZIP-Datei kann auch unter Entwickler in app.nemdisplay.dk hochgeladen werden. Ein Entwurf kann auf den eigenen Bildschirmen des Entwicklerkontos laufen. - Zur Prüfung einreichen.
nd-app submitsendet die Version zur Prüfung an NemDisplay. - Kunden fügen sie hinzu. Eine freigegebene App wird in app.nemdisplay.dk unter App hinzufügen → Von Partnern aufgeführt, mit Ihrem Firmennamen und den Domains, von denen die App Daten holt.
Das Entwicklerkonto
- Kostenlos, ohne Abonnement und ohne Testzeitraum, der abläuft.
- Für Unternehmen mit einer dänischen CVR-Nummer.
- Höchstens 3 Bildschirme beliebigen Playertyps, damit die App auf echter Hardware getestet werden kann.
- Die Bildschirme des Kontos zeigen den Hinweis „Entwicklerkonto – nicht für den Produktivbetrieb“. Das Konto dient der Entwicklung, dem Testen und der Vorführung.
- Die Anmeldung mit Zwei-Faktor-Authentifizierung ist Pflicht.
- Das Menü Entwickler in app.nemdisplay.dk: Ihre Apps, Versionen mit Befunden und Prüfantworten, Upload, Ihre eigenen Secrets und ein Test der Datenquelle.
Sie erstellen das Konto selbst (auf Dänisch) mit Ihrer CVR-Nummer und teilen uns mit, was Sie bisher entwickelt haben und welche Apps Sie planen. Wir prüfen die Anmeldung, in der Regel innerhalb von 3 Werktagen. Für das Konto gelten die Entwicklervereinbarung (Englisch) und die Nutzungsbedingungen (Englisch).
Das Toolkit nd-app
Eine Vorlage, ein lokaler Emulator mit derselben Sandbox und CSP wie auf dem Bildschirm, dieselbe Validierung wie auf dem Server, Packen und Hochladen. Es benötigt Node.js 18 oder neuer und hat keine Abhängigkeiten. Die ZIP-Datei enthält das Werkzeug, das SDK, die Vorlage, die Beispiel-App „Dagens menu“ und die Anleitung (README.md, auf Dänisch).
# im entpackten Ordner nd-app-devkit/ node devkit/bin/nd-app.js init canteen-menu # neue App aus der Vorlage cd canteen-menu node ../devkit/bin/nd-app.js dev # Emulator auf http://localhost:5173 node ../devkit/bin/nd-app.js validate # dieselben Prüfungen wie auf dem Server node ../devkit/bin/nd-app.js pack # dist/<id>-<version>.zip node ../devkit/bin/nd-app.js publish # als Entwurf hochladen (ND_API_KEY, ND_ACCOUNT) node ../devkit/bin/nd-app.js submit 1.0.0 --note "Erste Version"
Mit npm link in devkit/ funktioniert das Werkzeug als Befehl nd-app. Der Emulator hat eine Steuerleiste für Bildschirmgröße (1920 × 1080, 1080 × 1920, 4K), Zonen, Sprache, Design, online/offline, veraltete Daten, keine Daten und Ein-/Ausblenden sowie einen Protokollbereich mit allen Nachrichten, dem Protokoll der App und CSP-Verstößen. publish und submit verwenden einen API-Schlüssel mit der Rolle Redakteur oder Administrator im Entwicklerkonto.
Das SDK
nd-sdk.js und nd-tokens.css verbinden die App mit dem Player. Die Vorlage lädt sie.
nd.ready(ctx => render()); // erstes Zeichnen, einmal nach init nd.onShow(fn) nd.onHide(fn) // die Slide wird sichtbar / verlässt den Bildschirm nd.onData((data, meta) => render()); // neue Daten vom Daten-Proxy nd.onResize(fn) nd.onOnline(fn) nd.settings nd.data nd.meta nd.locale nd.theme nd.size nd.online nd.t("menu.title", { count: 3 }) // Übersetzung aus i18n/da.json und en.json nd.format.date(nd.now(), "time") // Sprache und Uhrzeit des Bildschirms nd.format.number(85, { style: "currency", currency: "DKK" }) nd.done() // die Slide vorzeitig beenden nd.log.info(msg) nd.log.warn(msg) nd.log.error(msg)
| Feld | Inhalt |
|---|---|
nd.settings | Die Einstellungen des Kunden aus dem Formular in app.nemdisplay.dk. Geheime Felder sind nie enthalten. |
nd.data, nd.meta | Daten aus der Datenquelle und {fetchedAt, stale}. Fällt die Quelle aus, bleiben die letzten gültigen Daten mit stale: true erhalten. |
nd.locale | Die Sprache des Bildschirms, da oder en. |
nd.theme | Das Design des Kontos {font, bg, text, accent}, auch als --nd-font, --nd-bg, --nd-text und --nd-accent. |
nd-t-* | Die Typografie der eigenen Apps von NemDisplay: nd-t-title, nd-t-label, nd-t-big, nd-t-body, nd-t-meta, nd-t-source und nd-t-muted. Die Größen richten sich nach der Zone der App. |
Das Manifest
manifest.json im Stammverzeichnis der ZIP-Datei beschreibt die App, die Felder, die der Kunde ausfüllt, und woher die Daten kommen.
{
"manifest_version": 1,
"id": "dk.kantinekassen.menu",
"version": "1.2.0",
"name": { "da": "Dagens menu", "en": "Today's menu" },
"developer": { "name": "Kantinekassen ApS", "support_email": "support@kantinekassen.dk" },
"entry": "index.html",
"sdk": "^1.0",
"renderer": "bundle",
"settings": [
{ "key": "shop_id", "type": "text", "required": true, "label": { "da": "Butiks-id", "en": "Shop ID" } },
{ "key": "api_key", "type": "secret", "required": true, "label": { "da": "API-nøgle", "en": "API key" } }
],
"data": {
"source": "http",
"url": "https://api.kantinekassen.dk/v2/shops/{{settings.shop_id}}/menu/today",
"headers": { "Authorization": "Bearer {{settings.api_key}}" },
"allowed_hosts": ["api.kantinekassen.dk"],
"refresh_seconds": 900,
"personal_data": "none"
},
"permissions": [],
"locales": ["da", "en"],
"preview": { "settings": { "shop_id": "demo" }, "data": "preview/data.json" }
}
- Pflichtfelder:
manifest_version,idin umgekehrter Domain-Schreibweise,version(semver, jeder Upload hat seine eigene),nameauf Dänisch und Englisch,developer.nameunddeveloper.support_email,entry,sdkundrenderer. - Einstellungen: höchstens 30 Felder der Typen
text,textarea,number,bool,selectundsecret. Der Kunde füllt sie aus, wenn er die App hinzufügt. - Datenquelle:
http,webhookodernone. Mitwebhooksendet Ihr eigenes System JSON an die Webhook-Adresse der Installation, die der Kunde in den Einstellungen der App sieht; die Bildschirme zeigen die neuen Daten innerhalb einer Minute. - Ohne eigenen Code:
rendererkannnd:table,nd:listodernd:cardsstattbundlesein. Der Player zeichnet Ihre Daten dann auf einer Vorlage von NemDisplay im Thema des Bildschirms, und die Zip enthält nur das Manifest.templatesagt, wo die Zeilen in den Daten liegen (items), welche Felder gezeigt werden (fieldsmitpath,label,format) und den Titel. - Schlüssel nur in Headern, noch keine personenbezogenen Daten. Die Schlüssel des Kunden und Ihre eigenen dürfen nur in
headersstehen, nie in der Adresse.personal_datamuss"none"sein: Apps, deren Datenquelle personenbezogene Daten liefert, werden derzeit noch nicht angenommen.
Regeln und Grenzen
- Das Bundle: höchstens 10 MB gepackt, 30 MB entpackt und 500 Dateien. Nur
html js css svg png jpg jpeg webp gif woff2 json txt mp4 webm. - Kein Netzwerk aus der App. Die CSP blockiert
fetch,XMLHttpRequest,WebSocketund Dateien von anderen Domains. Skripte, Styles, Schriften und Bilder müssen im Bundle enthalten sein. - Daten nur über die Datenquelle. Die Adresse muss https sein, der Host muss in
allowed_hostsstehen, und die Antwort muss JSON von höchstens 256 KB sein. - Aktualisierung:
refresh_secondsbeträgt mindestens 60 Sekunden. - Keine Inline-Skripte, kein
evalund keinnew Functionsowie keine externen Skripte. permissionsmuss leer sein.
Prüfung
- Automatisch beim Upload: das Manifest, Dateitypen, Größen und eine statische Prüfung des Codes. Bei Fehlern wird die Version nicht gespeichert, und die Befunde werden in nd-app und unter Entwickler angezeigt.
- Automatischer Testlauf: innerhalb weniger Minuten läuft die Version in Headless Chrome mit den
preview-Einstellungen und -Daten des Manifests, in 1920×1080 und 1080×1920, auf Dänisch und Englisch. Vier Screenshots und Befunde (keinhello, keinready, Fehler im Log, leeres Bild) stehen an der Version unter Entwickler und beim Prüfer von NemDisplay. - Manuell durch NemDisplay, bevor eine Version Kunden erreicht: dass die App stabil auf dem Player läuft, ohne Daten und ohne Netzwerk etwas Sinnvolles zeigt,
nd-t-*verwendet, Texte auf Dänisch und Englisch hat und nur Daten von den Domains im Manifest holt. - Antwortzeit: Ziel ist eine Antwort innerhalb von 3 Werktagen. Eine Ablehnung wird begründet.
- Versionen können nach dem Upload nicht mehr geändert werden. NemDisplay kann eine Version oder eine App von allen Bildschirmen zurückziehen.
Preis
Das Entwicklerkonto ist kostenlos. Vorerst sind alle Apps von Partnern für Kunden kostenlos.
Loslegen
Support · Nutzungsbedingungen (Englisch) · Datenschutzerklärung (Englisch) · NemDisplay wird von MGJ Development betrieben, CVR 31961742.