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

1const { NukioClient } = require("nukio-sdk");
2async function main() {
3 const api = new NukioClient();
4 await api.login({
5 accountID: "yourAccount",
6 userID: "yourUser",
7 password: "yourPassword"
8 });
9 const devices = await api.api.device.getAllDevices();
10 console.log(devices);
11}
12main().catch(console.error);

Available API Groups

1api.api.authentication
2api.api.device
3api.api.user
4api.api.geozone
5api.api.fleets
6api.api.notifications
7api.api.routes
8api.api.passengers
9api.api.accountStatus

Example: Get Geozones

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

Example: Get Device

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

npm Package

Package name:

1nukio-sdk

Latest version:

1npm view nukio-sdk version