← API documentation

Build with the API

Examples

Working examples on this tenant's API. Open an example to explore it, or save the single HTML file and run it locally.

API login

Not logged in

Sign in once for all manager examples on this API address in this browser. Login is remembered until logout or session expiry. API keys are never saved.

EndpointUsed by all manager examples
POST /api/v1/session/loginExchange the manager KID and API key for a shared bearer session.
POST /api/v1/session/renewRenew a valid session during use and validate remembered login.

Public widgets work without manager login.

Single HTML file · Shared manager login

Machine timeline

Explore one machine's settings, live measurements, states, purchases, resident events, reservations and messages in chronological order, with time navigation, filters and wash documents.

Open timeline →
EndpointUsed for
GET /api/v1/units/{unitKid}/timeline/fieldsAuthorized machine context, log categories and readable fields.
GET /api/v1/units/{unitKid}/timelineChronological Log0–Log6 pages in an interval of at most 24 hours.
GET /api/v1/documents/{cycleKid}/graph2.svg and /tableAuthorized wash graph and measurements.

Save unit-timeline.html · Requires Offline3 (32), Bank/Location/Unit Read and matching resource grants. Personal data requires additional permissions; credential fields remain excluded. Includes a synthetic demo. Unreleased.

Single HTML file · Shared manager login

Resident lookup

Find a resident by email, phone, activation code or KID across all authorized banks. Open the selected Nortec resident’s eVaskeri account in a new window.

Find a resident →
EndpointUsed for
GET /api/v1/search/users?q=…Look up a complete email address across authorized banks.
GET /api/v1/search/user-sms?q=…Look up a complete phone number, including Danish national/international variants.
GET /api/v1/search/user-activation?q=…Find a resident by activation code.
GET /api/v1/search/users?q=…&kidOnly=trueFind an exact resident KID.
POST /api/v1/users/{userKid}/evaskeri-sessionOpen eVaskeri as the selected resident (Nortec).

Save resident-lookup.html · Requires Users2 (53), User Read and resource grants. Bank Read adds bank names. eVaskeri requires User Create and whole-bank access. Includes a synthetic demo. Maximum 50 residents; partial results are marked. Alfa preview; not released to beta/production.

Single HTML file · Shared manager login

Settlement checklist

Compare invoice, soap invoice, soap credit and EasyPay processing across recent periods. Bank-wide rows show the settlement schedule.

Open settlement checklist →
GET /api/v1/settlement-checklistAuthorized checklist with optional bank/location scope and pagination.
GET /api/v1/settlement-checklist/{periodKid}Current status and dates for one period.

Save settlement-checklist.html · Requires Checklist1 (10), Bank/Location Read and resource grants. Includes a synthetic demo and local print view. Alfa preview; not released to beta/production.

Single HTML file · Shared manager login

Error history

Search a bank, filter machine errors by period and level, load more events and inspect details. Authorized managers can acknowledge an event while preserving its log.

Open error history →
OperationPurpose
GET /api/v1/search/banksFind an authorized bank without requiring Banks2.
GET /api/v1/banks/{bankKid}/errorsFilter and page Errors2 history.
GET /api/v1/errors/{errorKid}Read current event details.
POST /api/v1/errors/{errorKid}/acknowledgeAcknowledge with the current revision and an explicit confirmation.

Save errors.html · Requires Errors2 (17), Bank/Location/Unit Read and resource grants. Acknowledgement requires Unit Write. Includes a synthetic demo and local print view. Alfa preview; not released to beta/production.

Single HTML file · Shared manager login

Out of service

Manual shutdowns, automatic shutdowns and machines under repair. Shows the machine, organisation, location, type, status, editor and time. Managers with Unit Write can explicitly return a machine to service.

Open machines →
EndpointUsed for
GET /api/v1/units/out-of-serviceFollow cursor pages of the authorized OutOfOrder1 directory.
POST /api/v1/units/{unitKid}/out-of-service/restoreSet OutOfOrder to Enabled (0), using the displayed revision and a confirmation. A saved change is not a device acknowledgement.

Save out-of-order.html · Requires OutOfOrder1 (59), Bank/Location/Unit Read and resource grants. Restore also requires Unit Write. A synthetic demo is available without login. Implemented on alfa; not released to beta/production.

Single HTML file · Manager login

Cycle viewer

Browse cycles in random order from your accessible intelligent machines. The last 16 fetched documents appear as cycle widgets or a list; select one to open the same full graph component used by the portal, loaded from this API.

Open viewer →

Login is remembered in this browser until logout or session expiry. The API key is never stored. New arrivals replace older documents in memory; no document files are downloaded. A synthetic demo is available without login.

EndpointUsed for
GET /api/v1/unitsRead the manager's accessible units with fields=unitType and cursor paging; select intelligent machine types before fetching their cycles.
GET /api/v1/units/{unitKid}/documentsPage through the document history of each unit.
GET /api/v1/documents/{cycleKid}/graphRead measurements and events for the interactive Chart.js graph.
GET /components/cycle/js/cycle-component.mjsLoad the shared portal graph, its dependencies and CSS. Also needed when this HTML file is used locally.
GET /api/v1/public/cycle-chart/presentationGet the portal graph’s translated labels and control identifiers.
GET /api/v1/public/widgetsLoad the public widgets' translated labels and tenant presentation.
GET /api/v1/public/widgets/cycle?cycleKid=…Show the square cycle widget in grid view. Public visibility is checked separately; a private document can have an unavailable widget.

Save cycles.html · Requires Units1, WashDoc3 and permission to read the selected documents and resources. Host has no units; use the demo there. Local setup instructions are inside the viewer.

Single HTML file · Shared manager login

Automatically out of service

Cards for machines that automatically went out of service, using the same status data as the portal. Shows machine, organisation, location, error code and time, with search and a 30-second refresh while visible.

Open alerts →
EndpointUsed for
GET /api/v1/tenant/status/pageFollow all pages of the authorized snapshot and select AutoOutOfOrder alerts. Source limits and failures are shown explicitly.
GET /api/v1/icon/line/{iconKid}.svgShow the API's machine warning, organisation and location line icons.

Save auto-out-of-order.html · Requires TenantStatus1 (80), Bank Read, Location Read, Unit Read and matching resource grants. Host has no machines; use the demo there. Local setup instructions are inside the example.

Single HTML file · Shared manager login

Offline laundries

Laundries with offline terminals, split into Credit and Cash bank types. One card per laundry, with its organisation, last-contact times and terminal details. Search and automatic refresh every 30 seconds while visible.

Open laundries →
EndpointUsed for
GET /api/v1/tenant/status/pageFollow all pages, select Offline alerts, group by locationKid and split by bankType. Cash requires at least one hour without contact; Credit at least one day. API limits and failures remain visible.
GET /api/v1/icon/line/{iconKid}.svgDisplay the API's organisation and laundry icons.

Save offline-laundries.html · Requires TenantStatus1 (80), Bank Read, Location Read, Unit Read and matching resource grants. Other bank types are shown separately. A laundry can have both offline and online terminals.

Public · No login

Running machines

Show the complete list of running machines, their type, cycle, progress and remaining minutes.

Open running machines →

GET /api/v1/public/statistics/running-units · Refreshes once per minute · Unreleased.

Public · No login

Widgets for your website

Live, copyable examples for cycles, running machines, purchases, reservations and active users. Each widget lists its API requests and refresh interval.

Explore widgets →

Uses GET /api/v1/public/widgets for presentation, plus the public read endpoints documented beside each example.