tuya-connector
?
What is Tuya Open Platform—API Reference
Tuya provides a set of HTTP APIs and signature verification logic. You need to implement the logic when you make the API requests.
tuya-connector
provides capabilities to sign a request, refresh, store, and renew a token, and encapsulate common APIs, helping you quickly connect to Tuya's open platform.
Install
npm install @tuya/tuya-connector-nodejs
# or
yarn add @tuya/tuya-connector-nodejs
Get started
import { TuyaContext } from '@tuya/tuya-connector-nodejs';
const tuya = new TuyaContext({
baseUrl: 'https://openapi.tuyacn.com',
accessKey: 'xx',
secretKey: 'xx',
});
const device = await tuya.device.detail({
device_id: 'device_id'
});
Advanced development
tokenStore
Custom By default, tokenStore
is implemented based on memory. We recommend that you implement the store instance in your service. In the following code block, the Redis Store is used as an example.
// tokenStore.ts
import { TuyaTokenStorInterface, TuyaTokensSave } from '@tuya/tuya-connector-nodejs';
import IORedis from 'ioredis';
export class RedisTokenStore implements TuyaTokenStorInterface {
private readonly client: IORedis.Redis;
private readonly key: string;
constructor(client: IORedis.Redis, key: string = 'tuya::token') {
this.client = client;
this.key = key;
}
async setTokens(tokens: TuyaTokensSave): Promise<boolean> {
const res = await this.client.set(this.key, JSON.stringify(tokens));
return ! ! res;
}
async getAccessToken(): Promise<string | undefined> {
const jsonStr = await this.client.get(this.key) || '{}';
const tokens: TuyaTokensSave = JSON.parse(jsonStr);
return tokens && tokens.access_token;
}
async getRefreshToken(): Promise<string | undefined> {
const jsonStr = await this.client.get(this.key) || '{}';
const tokens: TuyaTokensSave = JSON.parse(jsonStr);
return tokens.refresh_token;
}
}
// index.ts
import { RedisTokenStore } from './tokenStore';
import IoRedis from 'ioredis';
const redis = new IoRedis();
const tuya = new TuyaContext({
baseUrl: 'https://openapi.tuyacn.com',
accessKey: 'xx',
secretKey: 'xx',
store: new RedisTokenStore(redis),
});
httpClient
Custom request of tuya-connector
uses Axios as httpClient
by default, and exposes replaceable parameters. If necessary, you can also customize httpClient
.
import axios from 'axios';
import { TuyaContext } from '@tuya/tuya-connector-nodejs';
const tuya = new TuyaContext({
baseUrl: 'https://openapi.tuyacn.com',
accessKey: 'xx',
secretKey: 'xx',
rpc: axios
});
Requests of other OpenAPIs
tuya-connector
encapsulates common APIs, and declares the types of request and response parameters. You can customize additional API requests.
import { TuyaContext } from '@tuya/tuya-connector-nodejs';
const tuya = new TuyaContext({
baseUrl: 'https://openapi.tuyacn.com',
accessKey: 'xx',
secretKey: 'xx',
});
const { data } = await tuya.request({
method: 'GET',
path: '/v1.0/xx',
body: {},
});
Other issues
-
Apply for an authorization key. On the platform, you can create a project to get the access ID and access secret of the cloud application.
-
For more information about global error codes, see Global Error Codes.