Lag apper for NemDisplay Ny
Lag en app i HTML, CSS og JavaScript som NemDisplays kunder kan sette på infoskjermene sine som et lysbilde i spillelisten.
Hva du kan lage
Apper som viser data fra dine egne eller kundenes systemer på infoskjermen, for eksempel dagens meny fra kantinesystemet, dagens bookinger eller ventetiden i en kø.
Kjører i en sandkasse
Hver app kjører i sin egen sandkasse-iframe på spilleren med en streng CSP. Den har ingen tilgang til spilleren, andre apper eller nettverket.
Data gjennom NemDisplay
NemDisplays dataproxy henter data fra adressen i manifestet og sender bare resultatet til infoskjermen. API-nøkler blir på serveren og når aldri infoskjermen.
Offline på boksen
Appens filer og de nyeste dataene lagres på spilleren, som bilder og video. Hvis nettverket faller ut, fortsetter appen med de siste dataene den fikk.
Alle skjermformater
Liggende og stående infoskjermer og soner i en layout. Appen får størrelsen sin fra spilleren og skalerer med NemDisplays typografi.
Slik fungerer det
- Lag appen. En app er en mappe med
manifest.json, HTML, CSS, JavaScript og oversettelser. Test den i emulatoren mednd-app dev. - Last opp en versjon.
nd-app publishvaliderer, pakker og laster opp appen som et utkast. Zip-filen kan også lastes opp under Utvikler i app.nemdisplay.dk. Et utkast kan kjøre på utviklerkontoens egne infoskjermer. - Send til gjennomgang.
nd-app submitsender versjonen til NemDisplay for gjennomgang. - Kundene legger den til. En godkjent app vises i app.nemdisplay.dk under Legg til app → Fra partnere, med firmanavnet ditt og domenene appen henter data fra.
Utviklerkontoen
- Gratis, uten abonnement og uten prøveperiode som går ut.
- For bedrifter med et dansk CVR-nummer.
- Høyst 3 infoskjermer av hvilken som helst spillertype, slik at appen kan testes på ekte maskinvare.
- Kontoens infoskjermer viser merket «Utviklerkonto – ikke til produksjon». Kontoen er til utvikling, testing og demonstrasjon.
- Innlogging med tofaktor er påkrevd.
- Menyen Utvikler i app.nemdisplay.dk: appene dine, versjoner med funn og svar fra gjennomgangen, opplasting, dine egne hemmeligheter og en test av datakilden.
Du oppretter kontoen selv (på dansk) med CVR-nummeret ditt og forteller oss hva du har laget før, og hvilke apper du planlegger å lage. Vi går gjennom registreringen, vanligvis innen 3 virkedager. Kontoen omfattes av utvikleravtalen (på engelsk) og vilkårene (på engelsk).
Verktøysettet nd-app
En mal, en lokal emulator med samme sandkasse og CSP som infoskjermen, samme validering som serveren, pakking og opplasting. Det krever Node.js 18 eller nyere og har ingen avhengigheter. Zip-filen inneholder verktøyet, SDK-en, malen, eksempelappen «Dagens menu» og veiledningen (README.md, på dansk).
# i den utpakkede mappen nd-app-devkit/ node devkit/bin/nd-app.js init canteen-menu # ny app fra malen cd canteen-menu node ../devkit/bin/nd-app.js dev # emulator på http://localhost:5173 node ../devkit/bin/nd-app.js validate # de samme kontrollene som serveren node ../devkit/bin/nd-app.js pack # dist/<id>-<version>.zip node ../devkit/bin/nd-app.js publish # last opp som utkast (ND_API_KEY, ND_ACCOUNT) node ../devkit/bin/nd-app.js submit 1.0.0 --note "Første versjon"
Med npm link i devkit/ fungerer verktøyet som kommandoen nd-app. Emulatoren har en kontrollinje for skjermstørrelse (1920 × 1080, 1080 × 1920, 4K), soner, språk, tema, online/offline, utdaterte data, ingen data og vis/skjul, og et loggpanel med alle meldinger, appens logg og CSP-brudd. publish og submit bruker en API-nøkkel med rollen redaktør eller administrator på utviklerkontoen.
SDK-en
nd-sdk.js og nd-tokens.css kobler appen til spilleren. Malen laster dem inn.
nd.ready(ctx => render()); // første tegning, én gang etter init nd.onShow(fn) nd.onHide(fn) // lysbildet blir synlig / forlater skjermen nd.onData((data, meta) => render()); // nye data fra dataproxyen 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 }) // oversettelse fra i18n/da.json og en.json nd.format.date(nd.now(), "time") // skjermens språk og tid nd.format.number(85, { style: "currency", currency: "DKK" }) nd.done() // avslutt lysbildet tidlig nd.log.info(msg) nd.log.warn(msg) nd.log.error(msg)
| Felt | Innhold |
|---|---|
nd.settings | Kundens innstillinger fra skjemaet i app.nemdisplay.dk. Hemmelige felt blir aldri tatt med. |
nd.data, nd.meta | Data fra datakilden og {fetchedAt, stale}. Hvis kilden svikter, beholdes de siste gode dataene med stale: true. |
nd.locale | Skjermens språk, 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 i NemDisplays egne apper: nd-t-title, nd-t-label, nd-t-big, nd-t-body, nd-t-meta, nd-t-source og nd-t-muted. Størrelsene følger appens sone. |
Manifestet
manifest.json i roten av zip-filen beskriver appen, feltene kunden fyller ut, og hvor dataene kommer fra.
{
"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åkrevd:
manifest_version,idi omvendt domeneform,version(semver, hver opplasting har sin egen),namepå dansk og engelsk,developer.nameogdeveloper.support_email,entry,sdkogrenderer. - Innstillinger: høyst 30 felt av typene
text,textarea,number,bool,selectogsecret. Kunden fyller dem ut når appen legges til. - Datakilde:
http,webhookellernone. Medwebhooksender ditt eget system JSON til installasjonens webhook-adresse, som kunden ser i appens innstillinger; skjermene viser de nye dataene innen ett minutt. - Uten egen kode:
rendererkan værend:table,nd:listellernd:cardsi stedet forbundle. Spilleren tegner da dataene dine på en av NemDisplays maler med skjermens tema, og zip-filen inneholder bare manifestet.templatesier hvor radene ligger i data (items), hvilke felt som vises (fieldsmedpath,label,format) og tittelen. - Nøkler bare i headere, ingen personopplysninger ennå. Kundens nøkler og dine egne kan bare stå i
headers, aldri i adressen.personal_datamå være"none": apper der datakilden leverer personopplysninger, godtas ikke ennå.
Regler og grenser
- Pakken: høyst 10 MB pakket, 30 MB utpakket og 500 filer. Bare
html js css svg png jpg jpeg webp gif woff2 json txt mp4 webm. - Ikke noe nettverk fra appen. CSP-en blokkerer
fetch,XMLHttpRequest,WebSocketog filer fra andre domener. Skript, stiler, skrifter og bilder må ligge i pakken. - Data bare gjennom datakilden. Adressen må være https, verten må stå i
allowed_hosts, og svaret må være JSON på høyst 256 KB. - Oppdatering:
refresh_secondser minst 60 sekunder. - Ingen inline-skript,
evalellernew Function, og ingen eksterne skript. permissionsmå være tom.
Gjennomgang
- Automatisk ved opplasting: manifestet, filtyper, størrelser og en statisk kontroll av koden. Ved feil lagres ikke versjonen, og funnene vises i nd-app og under Utvikler.
- Automatisk testkjøring: innen få minutter kjøres versjonen i headless Chrome med manifestets
preview-innstillinger og -data i 1920×1080 og 1080×1920 på dansk og engelsk. Fire skjermbilder og funn (ingenhello, ingenready, feil i loggen, tomt bilde) vises på versjonen under Utvikler og hos NemDisplays godkjenner. - Manuelt av NemDisplay før hver versjon når kundene: at appen kjører stabilt på spilleren, viser noe fornuftig uten data og uten nettverk, bruker
nd-t-*, har tekster på dansk og engelsk og bare henter data fra domenene i manifestet. - Svartid: målet er svar innen 3 virkedager. Et avslag kommer med en begrunnelse.
- Versjoner kan ikke endres etter opplasting. NemDisplay kan trekke tilbake en versjon eller en app fra alle infoskjermer.
Pris
Utviklerkontoen er gratis. Inntil videre er alle apper fra partnere gratis for kundene.
Kom i gang
Support · Vilkår (på engelsk) · Personvernerklæring (på engelsk) · NemDisplay drives av MGJ Development, CVR 31961742.