NemDisplayNemDisplay

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.

Opret udviklerkonto Hent udviklerværktøjet API-dokumentation

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

  1. Byg appen. En app er en mappe med manifest.json, HTML, CSS, JavaScript og oversættelser. Test den i emulatoren med nd-app dev.
  2. Upload en version. nd-app publish validerer, 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.
  3. Send til gennemgang. nd-app submit sender versionen til NemDisplay, som gennemgår den.
  4. 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

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.

Hent nd-app-devkit.zip

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)
FeltIndhold
nd.settingsKundens indstillinger fra formularen i app.nemdisplay.dk. Secret-felter er aldrig med.
nd.data, nd.metaData fra datakilden og {fetchedAt, stale}. Fejler kilden, beholdes de sidste gode data med stale: true.
nd.localeSkærmens sprog, da eller en.
nd.themeKontoens 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" }
}

Regler og grænser

Gennemgang

Pris

Udviklerkontoen er gratis. Indtil videre er alle apps fra partnere gratis for kunderne.

Kom i gang

Opret udviklerkonto Hent udviklerværktøjet API-dokumentation

Support · Vilkår · Privatlivspolitik · NemDisplay drives af MGJ Development, CVR 31961742.