Overview

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

Bash

Yarn

pnpm

Bun

PowerShell

$ npm install nukio-sdk

Quick Start

JavaScript

Python

Java

cURL

Shell

1 const { NukioClient } = require("nukio-sdk");
2 async 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 }
12 main().catch(console.error);

Available API Groups

JavaScript

Python

Java

cURL

Shell

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

Example: Get Geozones

JavaScript

Python

Java

cURL

Shell

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

Example: Get Device

JavaScript

Python

Java

cURL

Shell

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

npm Package

Package name:

JavaScript

Python

Java

cURL

Shell

1 nukio-sdk

Latest version:

JavaScript

Python

Java

cURL

Shell

1 npm view nukio-sdk version

1	const { NukioClient } = require("nukio-sdk");
2	async 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	}
12	main().catch(console.error);

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