Skip to navigation
Nukio API

Overview

View as Markdown

Nukio SDK

Documentation for installing and using the official Nukio SDK from npm. This section provides setup instructions, authentication examples, available API groups, and sample SDK calls for developers integrating Nukio into Node.js or TypeScript applications.

JavaScript / TypeScript SDK

The Nukio SDK provides a simple way to integrate with the Nukio API from Node.js applications.

Installation

npm install nukio-sdk

Quick Start

const { NukioClient } = require("nukio-sdk");
async function main() {
  const api = new NukioClient();
  await api.login({
    accountID: "yourAccount",
    userID: "yourUser",
    password: "yourPassword"
  });
  const devices = await api.api.device.getAllDevices();
  console.log(devices);
}
main().catch(console.error);

Available API Groups

api.api.authentication
api.api.device
api.api.user
api.api.geozone
api.api.fleets
api.api.notifications
api.api.routes
api.api.passengers
api.api.accountStatus

Example: Get Geozones

const geozones = await api.api.geozone.getGeozones();

Example: Get Device

const device = await api.api.device.getDevice("01");

npm Package

Package name:

nukio-sdk

Latest version:

npm view nukio-sdk version