NemDisplayNemDisplay

Bygg appar för NemDisplay Nyhet

Gör en app i HTML, CSS och JavaScript som NemDisplays kunder kan lägga på sina infoskärmar som en bild i spellistan.

Skapa ett utvecklarkonto (på danska) Ladda ner verktygslådan API-dokumentation

Vad du kan bygga

Appar som visar data från dina egna eller dina kunders system på skärmen, till exempel dagens meny från personalmatsalens system, dagens bokningar eller väntetiden i en kö.

Körs i en sandlåda

Varje app körs i sin egen sandlådade iframe på spelaren med en strikt CSP. Den har ingen åtkomst till spelaren, andra appar eller nätverket.

Data via NemDisplay

NemDisplays dataproxy hämtar data från adressen i manifestet och skickar bara resultatet till skärmen. API-nycklar stannar på servern och når aldrig skärmen.

Offline på boxen

Appens filer och senaste data lagras på spelaren, precis som bilder och video. Om nätverket går ner fortsätter appen att köras med de senaste data den fick.

Alla skärmformat

Liggande och stående skärmar samt zoner i en layout. Appen får sin storlek från spelaren och skalar med NemDisplays typografi.

Så fungerar det

  1. Bygg appen. En app är en mapp med manifest.json, HTML, CSS, JavaScript och översättningar. Testa den i emulatorn med nd-app dev.
  2. Ladda upp en version. nd-app publish validerar, paketerar och laddar upp appen som ett utkast. Zip-filen kan också laddas upp under Utvecklare i app.nemdisplay.dk. Ett utkast kan köras på utvecklarkontots egna skärmar.
  3. Skicka in för granskning. nd-app submit skickar versionen till NemDisplay för granskning.
  4. Kunderna lägger till den. En godkänd app listas i app.nemdisplay.dk under Lägg till app → Från partner, med ditt företagsnamn och de domäner som appen hämtar data från.

Utvecklarkontot

Du skapar kontot själv (på danska) med ditt CVR-nummer och berättar vad du har byggt tidigare och vilka appar du planerar att göra. Vi granskar ansökan, oftast inom 3 arbetsdagar. Kontot omfattas av utvecklaravtalet (på engelska) och villkoren (på engelska).

Verktygslådan nd-app

En mall, en lokal emulator med samma sandlåda och CSP som skärmen, samma validering som servern, paketering och uppladdning. Den kräver Node.js 18 eller senare och har inga beroenden. Zip-filen innehåller verktyget, SDK:n, mallen, exempelappen ”Dagens menu” och guiden (README.md, på danska).

# i den uppackade mappen nd-app-devkit/
node devkit/bin/nd-app.js init canteen-menu   # ny app från mallen
cd canteen-menu
node ../devkit/bin/nd-app.js dev              # emulator på http://localhost:5173
node ../devkit/bin/nd-app.js validate         # samma kontroller som servern
node ../devkit/bin/nd-app.js pack             # dist/<id>-<version>.zip
node ../devkit/bin/nd-app.js publish          # ladda upp som utkast (ND_API_KEY, ND_ACCOUNT)
node ../devkit/bin/nd-app.js submit 1.0.0 --note "First version"

Med npm link i devkit/ fungerar verktyget som kommandot nd-app. Emulatorn har ett kontrollfält för skärmstorlek (1920 × 1080, 1080 × 1920, 4K), zoner, språk, tema, online/offline, inaktuella data, inga data och visa/dölj, samt en loggpanel med alla meddelanden, appens logg och CSP-överträdelser. publish och submit använder en API-nyckel med rollen Redaktör eller Administratör på utvecklarkontot.

Ladda ner nd-app-devkit.zip

SDK:n

nd-sdk.js och nd-tokens.css kopplar appen till spelaren. Mallen läser in dem.

nd.ready(ctx => render());                 // första ritningen, en gång efter init
nd.onShow(fn)  nd.onHide(fn)               // bilden blir synlig / lämnar skärmen
nd.onData((data, meta) => render());       // nya data från dataproxyn
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 })           // översättning från i18n/da.json och en.json
nd.format.date(nd.now(), "time")           // skärmens språk och tid
nd.format.number(85, { style: "currency", currency: "DKK" })
nd.done()                                  // avsluta bilden i förtid
nd.log.info(msg)  nd.log.warn(msg)  nd.log.error(msg)
FältInnehåll
nd.settingsKundens inställningar från formuläret i app.nemdisplay.dk. Hemliga fält skickas aldrig med.
nd.data, nd.metaData från datakällan och {fetchedAt, stale}. Om källan fallerar behålls de senaste fungerande data med stale: true.
nd.localeSkärmens språk, da eller en.
nd.themeKontots tema {font, bg, text, accent}, även som --nd-font, --nd-bg, --nd-text och --nd-accent.
nd-t-*Typografin i NemDisplays egna appar: nd-t-title, nd-t-label, nd-t-big, nd-t-body, nd-t-meta, nd-t-source och nd-t-muted. Storlekarna följer appens zon.

Manifestet

manifest.json i roten av zip-filen beskriver appen, de fält som kunden fyller i och var data kommer ifrån.

{
  "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 och gränser

Granskning

Pris

Utvecklarkontot är gratis. Tills vidare är alla appar från partner gratis för kunderna.

Kom igång

Skapa ett utvecklarkonto (på danska) Ladda ner verktygslådan API-dokumentation

Support · Villkor (på engelska) · Integritetspolicy (på engelska) · NemDisplay drivs av MGJ Development, CVR 31961742.