HTTP API reference

The HTTP API is a REST-style JSON API for reading and changing sites, layouts and devices, querying history, managing Push API subscriptions and running installation tools. Its OpenAPI description is generated from the code, so it is always complete; this page summarises it.

Conventions

Account and site. Most endpoints take Account and Site as query parameters (or account and site in the request body). Both are required, because a site ID is unique only within its account.

Device IDs. Devices are identified by their device ID, the serial number on the label. List parameters such as Devices are repeated in the query string: Devices=1234567&Devices=7654321. Leaving them out usually means “all devices you may access”, which can be a large response.

Live endpoints. A few endpoints, marked live below, read directly from the running site. Call them on the site’s node, found with GET /realtime/domain, not on api.noccela.io. Calling the wrong node, or a site that is offline, ends in a timeout.

Status codes.

Error bodies use the standard ProblemDetails JSON format.

A first request. GET /info returns your app’s client ID and the sites it may access:

curl -s https://api.noccela.io/info -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Endpoints

The groups below follow the tags of the OpenAPI description. “Base station” is called beacon or sensor in endpoint names.

Device information

Device modification

General information

History

GET /history needs a Start time or a Count. Start and Stop take ISO 8601 dates or times (the default span is the last 24 hours); Count returns the latest N rows per tag; IncludeProperties limits the fields returned; Timeout sets the database timeout in seconds (default 30). History stores a new row only when a tag has moved more than 0.5 m.

curl -s -G https://api.noccela.io/history \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  --data-urlencode "Account=YOUR_ACCOUNT_ID" \
  --data-urlencode "Site=YOUR_SITE_ID" \
  --data-urlencode "Devices=1234567" \
  --data-urlencode "Start=2026-10-21T06:00:00Z" \
  --data-urlencode "Stop=2026-10-21T14:00:00Z"

Event API (Push API)

Used to set up the Push API.

Installation tool

Planning and automatic calibration of base stations.

Integrations

Manage apps and their credentials programmatically, as in the partner portal.

Network

Real time

Site information

Site modification

Some changes, such as layout edits and base station positions, take effect only after a reload. If you make several changes, reload once at the end.

Workflows

Generate a client

Noccela does not ship HTTP client libraries; generate one from the OpenAPI description instead, so it always matches the API version you target. For example, with OpenAPI Generator:

npx @openapitools/openapi-generator-cli generate \
  -i https://api.noccela.io/swagger/v1/swagger.json \
  -g typescript-fetch \
  -o ./noccela-client

Generators exist for most languages: Python, Java, C#, Go and others.

Try it in Swagger UI

Open Swagger UI, select Authorize, and enter your client ID and secret. You do not need to tick the global scope; every client has it. Then choose an endpoint, select Try it out, fill in the parameters and select Execute.