Terms

Last Updated on : 2023-12-07 03:02:55download

This topic describes the common concepts in the documentation related to the Cloud Development Platform.

Term	Type	Description
OAuth 2.0	Computer term	Open Authorization (OAuth) is a development standard that allows a user to authorize third-party applications to access or control assets such as devices and scene data of the user on Tuya IoT Platform, without entering a username and password. Examples of application scenarios for different objects are as follows: Consumer: A user of the Tuya Smart app authorizes third-party cloud voice platforms, such as Amazon Alexa and Google Home, to control the devices under the account. Business: Based on the cloud application key issued by Tuya, the developer obtains or controls data of users, devices, products, apps, and more, without entering a username and password.
Simple mode	Computer term	Simple mode is one of the authorization modes in the OAuth 2.0 protocol specification. It is also known as the client credentials grant mode. The client accesses the interface based on the Tuya interface specification. After the Tuya authentication server completes the authentication, an access token is issued.
Authorization code mode	Computer term	Authorization code mode is one of the authorization modes in the OAuth 2.0 protocol specification. It is also known as the authorization code grant mode. The client uses the authorization code to exchange access tokens, and then gain access to user data.
access_token	Computer term	Access token, also called authentication credential, must be provided when calling Tuya OpenAPI. Only after the authentication is completed by the Tuya authentication server, can relevant business operations be carried out.
refresh_token	Computer term	Refresh token. When the access token becomes invalid, a new access token can be obtained through the refresh token that can be used only once.
API	Computer term	An application programming interface (API) refers to pre-defined functions or conventions to connect different components of a software system. The API provides a set of routines (a collection of functional interfaces or services) that applications and developers can access based on software or hardware, without accessing the original code or understand the internal working mechanism.
RESTful	Computer term	RESTful is a design style and development method for web applications. Based on HTTP, it can be defined in XML or JSON format. RESTful is suitable for scenarios where mobile Internet service providers serve business enabling interfaces, so a third-party can call mobile network resources in the way of over the top (OTT). The action types include adding, changing, and deleting the called resources. Tuya IoT Platform provides interface services to external developers with a RESTful API.
Message queuing	Computer term	The message queue refers to the container in which messages are stored during transmission.
Pulsar	Computer term	Pulsar is a multi-tenant and high-performance server-to-server messaging solution. Originally developed by Yahoo, it is now managed by The Apache Software Foundation. Tuya has made customized improvements based on the open-source Pulsar system. Tuya actively pushes event data to external partners through Pulsar. Pulsar SDK provided by Tuya can implement message access and address needs of partners for real-time messaging and message persistence.
accessId and accessKey	Business term	It is also called a cloud application key pair. After a cloud application is created on the Tuya IoT Platform, accessId and accessKey are generated by default in the background. They are used for authorization and interface authentication.
Standardization	Business term	Standardization means that in the practice of product connection, regarding repetitive control protocols and concepts, Tuya IoT Platform has unified things data models across categories and formulated unified control protocols. Through one product connection on the Tuya IoT Platform, developers can control products of multiple models in the same category. In this way, reduce the complicated workload caused by repeated connection, thereby improving efficiency.
Instruction set	Business term	One or more sets of control instructions used to control the devices. They are distinguished by product categories. The instruction set under the same category includes the instruction set collections under different PIDs of this category. That is, the instruction set at the PID dimension is a subset of the instruction set at the category dimension.
Status set	Business term	A collection used to describe the function status reported by the device. It is the same as the instruction set and is distinguished by product categories. The status set under the same category includes the status set collections under different PIDs of this category. That is, the status set at the PID dimension is a subset of the status set at the category dimension. Note: There is no strict one-to-one correspondence between the instruction set and the status set. Developers can use the instruction set or status set as needed based on the sending and reporting scenarios.
schema	Business term	The unique identifier of an app for user data isolation on Tuya IoT Platform. It is used in scenarios such as synchronizing users and querying users.
Alert message	Business term	When messages backlog in a third-party service, according to the alert parameters set by the developer on the Tuya IoT Platform, Tuya will send alert messages to the developer's registered mobile phone and email, and remind the third-party service developer to solve the problem as soon as possible.
Message subscription	Business term	Message subscription is a function that Tuya provides for third-party services to receive device messages. It allows third-party services to receive messages from smart devices connected to the Tuya IoT Platform.
Message backlog	Business term	When a third-party service is slow in processing messages and fails to consume timely due to program performance and other reasons, the messages pushed by the device will be backlogged in the Tuya Platform, waiting for the third-party service to consume and process.
WeChat mini program app ID	Business term	WeChat mini program app ID refers to a string of characters created by Tencent WeChat official development platform for each WeChat mini program. It is a unique identifier of the WeChat mini program.
WeChat mini program app secret	Business term	WeChat mini program app secret is an access key created by Tencent WeChat official development platform for each WeChat mini program. When the Tuya's cloud development service communicates with the WeChat server, the app secret is required for permission verification.
API grouping	Business term	API grouping is to group multiple APIs with common features. Usually, an API is grouped according to the functional modules to which the API belongs.