Byg apps til NemDisplay Ny
Lav en app i HTML, CSS og JavaScript, som NemDisplays kunder kan sætte på deres infoskærme som en slide i playlisten.
Hvad du kan bygge
Apps, der viser data fra dine egne eller dine kunders systemer på skærmen, fx dagens menu fra kantinesystemet, dagens bookinger eller ventetiden i en kø.
Kører i en sandkasse
Hver app kører i sin egen sandboxed iframe på afspilleren med en streng CSP. Den har ingen adgang til afspilleren, andre apps eller netværket.
Data via NemDisplay
NemDisplays data-proxy henter data fra den adresse, manifestet angiver, og sender kun resultatet til skærmen. API-nøgler bliver på serveren og når aldrig skærmen. Eller dit system sender data til NemDisplay (webhook).
Offline på boksen
Appens filer og de seneste data ligger på afspilleren ligesom billeder og video. Falder nettet ud, kører appen videre med de sidst hentede data.
Alle skærmformater
Liggende og stående skærme og rammer i et layout. Appen får sin størrelse fra afspilleren og skalerer med NemDisplays typografi.
Sådan virker det
- Byg appen. En app er en mappe med
manifest.json, HTML, CSS, JavaScript og oversættelser. Test den i emulatoren mednd-app dev. - Upload en version.
nd-app publishvaliderer, pakker og uploader appen som en kladde. Zip'en kan også uploades under Udvikler i app.nemdisplay.dk. En kladde kan køre på udviklerkontoens egne skærme. - Send til gennemgang.
nd-app submitsender versionen til NemDisplay, som gennemgår den. - Kunderne tilføjer den. En godkendt app ligger i app.nemdisplay.dk under Tilføj app → Fra partnere med dit firmanavn og de domæner, appen henter data fra.
Udviklerkontoen
- Gratis, uden abonnement og uden en prøveperiode, der udløber.
- For firmaer med et CVR-nummer.
- Højst 3 skærme af alle afspillertyper, så appen kan testes på rigtigt udstyr.
- Kontoens skærme viser mærket "Udviklerkonto – ikke til drift". Kontoen er til udvikling, test og demonstration.
- To-faktor er krævet ved login.
- Menuen Udvikler i app.nemdisplay.dk: dine apps, versioner med fund og svar fra gennemgangen, upload, dine egne secrets og en test af datakilden.
Du opretter selv kontoen med CVR-nummer og fortæller, hvad I har bygget før, og hvilke apps I vil lave. Vi gennemgår tilmeldingen, normalt inden for 3 hverdage. Kontoen følger udvikleraftalen og vilkårene.
Udviklerværktøjet nd-app
En skabelon, en lokal emulator med samme sandkasse og CSP som skærmen, den samme validering som serveren, pakning og upload. Kræver Node.js 18 eller nyere og har ingen afhængigheder. Zip'en indeholder værktøjet, SDK'et, skabelonen, eksempel-appen "Dagens menu" og vejledningen (README.md).
# i den udpakkede mappe nd-app-devkit/ node devkit/bin/nd-app.js init kantine-menu # ny app fra skabelonen cd kantine-menu node ../devkit/bin/nd-app.js dev # emulator på http://localhost:5173 node ../devkit/bin/nd-app.js validate # samme tjek som serveren node ../devkit/bin/nd-app.js pack # dist/<id>-<version>.zip node ../devkit/bin/nd-app.js publish # upload som kladde (ND_API_KEY, ND_ACCOUNT) node ../devkit/bin/nd-app.js submit 1.0.0 --note "Første version"
Med npm link i devkit/ kan værktøjet bruges som kommandoen nd-app. Emulatoren har en kontrolbjælke til skærmstørrelse (1920 × 1080, 1080 × 1920, 4K), rammer, sprog, tema, online/offline, forældede data, ingen data og vis/skjul, og en log-rude med alle beskeder, appens log og CSP-brud. publish og submit bruger en API-nøgle med rollen Redaktør eller Administrator på udviklerkontoen.
SDK'et
nd-sdk.js og nd-tokens.css er appens forbindelse til afspilleren. Skabelonen indlæser dem.
nd.ready(ctx => render()); // første tegning, én gang efter init nd.onShow(fn) nd.onHide(fn) // slidet bliver synligt / forlader skærmen nd.onData((data, meta) => render()); // nye data fra data-proxyen 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 }) // oversættelse fra i18n/da.json og en.json nd.format.date(nd.now(), "time") // skærmens sprog og tid nd.format.number(85, { style: "currency", currency: "DKK" }) nd.done() // afslut slidet før tid nd.log.info(msg) nd.log.warn(msg) nd.log.error(msg)
| Felt | Indhold |
|---|---|
nd.settings | Kundens indstillinger fra formularen i app.nemdisplay.dk. Secret-felter er aldrig med. |
nd.data, nd.meta | Data fra datakilden og {fetchedAt, stale}. Fejler kilden, beholdes de sidste gode data med stale: true. |
nd.locale | Skærmens sprog, da eller en. |
nd.theme | Kontoens tema {font, bg, text, accent}, også som --nd-font, --nd-bg, --nd-text og --nd-accent. |
nd-t-* | Typografien fra NemDisplays egne apps: nd-t-title, nd-t-label, nd-t-big, nd-t-body, nd-t-meta, nd-t-source og nd-t-muted. Størrelserne følger appens ramme. |
Manifestet
manifest.json i roden af zip'en beskriver appen, de felter kunden udfylder, og hvor data hentes.
{
"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" }
}
- Påkrævet:
manifest_version,idi omvendt domæneform,version(semver, hver upload har sin egen),namepå dansk og engelsk,developer.nameogdeveloper.support_email,entry,sdkogrenderer. - Indstillinger: højst 30 felter af typerne
text,textarea,number,bool,selectogsecret. Kunden udfylder dem, når appen tilføjes. - Datakilde:
http,webhookellernone. Medhttpindsætter{{settings.…}}kundens felter og{{secrets.…}}dine egne secrets i adressen og headers. Medwebhooksender dit eget system JSON til installationens webhook-adresse, som kunden ser på appens indstillinger; skærmene viser de nye data inden for et minut. - Uden egen kode:
rendererkan værend:table,nd:listellernd:cardsi stedet forbundle. Så tegner afspilleren dine data på en af NemDisplays skabeloner med skærmens tema, og zip'en indeholder kun manifestet.templatesiger, hvor rækkerne ligger i data (items), hvilke felter der vises (fieldsmedpath,label,format) og titlen.
Regler og grænser
- Bundlen: højst 10 MB pakket, 30 MB udpakket og 500 filer. Kun
html js css svg png jpg jpeg webp gif woff2 json txt mp4 webm. - Intet netværk fra appen. CSP'en blokerer
fetch,XMLHttpRequest,WebSocketog filer fra andre domæner. Scripts, styles, fonte og billeder skal ligge i bundlen. - Data kun gennem datakilden. Adressen skal være https, værten skal stå i
allowed_hosts, og svaret skal være JSON på højst 256 KB. - Nøgler kun i headere, ingen personoplysninger endnu. Kundens nøgler og dine egne må kun stå i
headers, aldrig i adressen.personal_dataskal være"none": apps, hvis datakilde leverer personoplysninger, tages ikke imod endnu. - Opdatering:
refresh_secondser mindst 60 sekunder. - Ingen inline-scripts,
evalellernew Function, og ingen eksterne scripts. permissionsskal være tom.
Gennemgang
- Automatisk ved upload: manifestet, filtyper, størrelser og et statisk tjek af koden. Med fejl gemmes versionen ikke, og fundene vises i nd-app og under Udvikler.
- Automatisk testkørsel: inden for få minutter køres versionen i headless Chrome med manifestets
preview-indstillinger og -data i 1920×1080 og 1080×1920 på dansk og engelsk. Fire skærmbilleder og fund (ingenhello, ingenready, fejl i loggen, tomt billede) vises på versionen under Udvikler og hos NemDisplays godkender. - Manuelt af NemDisplay før hver version kommer ud til kunderne: at appen kører stabilt på afspilleren, viser noget fornuftigt uden data og uden net, bruger
nd-t-*, har tekster på dansk og engelsk og kun henter data fra de domæner, der står i manifestet. - Svartid: målet er svar inden for 3 hverdage. En afvisning kommer med en begrundelse.
- Versioner kan ikke ændres efter upload. NemDisplay kan trække en version eller en app tilbage fra alle skærme.
Pris
Udviklerkontoen er gratis. Indtil videre er alle apps fra partnere gratis for kunderne.
Kom i gang
Support · Vilkår · Privatlivspolitik · NemDisplay drives af MGJ Development, CVR 31961742.