NemDisplayNemDisplay

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.

Opprett en utviklerkonto (på dansk) Last ned verktøysettet API-dokumentasjon

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

  1. Lag appen. En app er en mappe med manifest.json, HTML, CSS, JavaScript og oversettelser. Test den i emulatoren med nd-app dev.
  2. Last opp en versjon. nd-app publish validerer, 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.
  3. Send til gjennomgang. nd-app submit sender versjonen til NemDisplay for gjennomgang.
  4. 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

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.

Last ned nd-app-devkit.zip

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)
FeltInnhold
nd.settingsKundens innstillinger fra skjemaet i app.nemdisplay.dk. Hemmelige felt blir aldri tatt med.
nd.data, nd.metaData fra datakilden og {fetchedAt, stale}. Hvis kilden svikter, beholdes de siste gode dataene med stale: true.
nd.localeSkjermens språk, da eller en.
nd.themeKontoens 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" }
}

Regler og grenser

Gjennomgang

Pris

Utviklerkontoen er gratis. Inntil videre er alle apper fra partnere gratis for kundene.

Kom i gang

Opprett en utviklerkonto (på dansk) Last ned verktøysettet API-dokumentasjon

Support · Vilkår (på engelsk) · Personvernerklæring (på engelsk) · NemDisplay drives av MGJ Development, CVR 31961742.