nukio-sdk
v1.1.0
Published
SDK TypeScript para Nukio API
Readme
Nukio SDK
Official TypeScript/JavaScript SDK for the Nukio Asset Protection API.
Features
- Authentication and token management
- Device management
- Geozone operations
- Route and tracking services
- Command execution
- Notifications and reporting
- TypeScript support
- Promise-based API
- Node.js compatible
Installation
npm install @aperez5610/nukio-sdkQuick Start
import { NukioClient } from "@aperez5610/nukio-sdk";
const nukio = new NukioClient();
async function main() {
await nukio.login({
accountID: "yourAccount",
userID: "yourUser",
password: "yourPassword"
});
const devices = await nukio.getAllDevices();
console.log(devices);
}
main();Authentication
const nukio = new NukioClient();
await nukio.login({
accountID: "yourAccount",
userID: "yourUser",
password: "yourPassword"
});You can also provide an existing token:
const nukio = new NukioClient({
token: "your-access-token"
});Available Methods
Login
await nukio.login({
accountID: "yourAccount",
userID: "yourUser",
password: "yourPassword"
});Get All Devices
const devices = await nukio.getAllDevices();Get Device Details
const device = await nukio.getDevice("DEVICE_ID");Generic Request
const response = await nukio.request(
"GET",
"/device/getalldevices/authorization"
);Configuration
const nukio = new NukioClient({
baseUrl: "https://app.nukio.mx/api/v1",
token: "your-token"
});TypeScript Support
The SDK ships with full TypeScript declarations and IntelliSense support.
Requirements
- Node.js 18+
- npm 9+
API Documentation
This SDK is generated from the Nukio OpenAPI 3.1 specification and follows the official API structure.
License
MIT
Author
Alejandro Perez
Support
For bug reports, feature requests, and contributions, please open an issue on GitHub.
