Docs

Glossary

Last Updated on : 2020-09-18 09:52:37download

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

Term Type Description
OAuth 2.0 Computer term OAuth (Open Authorization) is a development standard that allows users to authorize third-party applications to access or control assets such as devices and scene data of the user on Tuya Cloud, without providing a username and password. Examples of application scenarios for different objects are as follows:
– Consumer: a user of Tuya Smart app authorizes the third-party cloud voice platforms, such as Alexa and Google Home, to control the devices under the account.
– Business: A developer can obtain or control the developer's resource data, such as user data, device data, product data, and app data, based on the cloud application key issued by Tuya without entering account passwords.
Simple mode Simple mode is one of the authorization modes in the OAuth 2.0 protocol specification. It is also known as the Client Credentials Grant. The client accesses the interface based on the Tuya interface specification. After Tuya authentication server completes the authentication, it can issue an access token.
Authorization code mode 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 thus gain access to user data.
access_token Access token, also called authentication credential, must be provided when calling Tuya Cloud Open API. Only after you complete the authentication by Tuya authentication server, can relevant business operations be carried out.
refresh_token Refresh token. When the access token becomes invalid, a new access token can be obtained through the refresh token. The refresh token can be used only once.
API Application programming interface (API) refers to pre-defined functions, or conventions to connect different components of a software system. API is used to provide a set of routines (a collection of functional interfaces or services) that applications and developers can access based on certain software or hardware, without having to access the original code or understand the details of the internal working mechanism.
RESTful RESTful is a design style and development method for web applications. Based on HTTP, it can be defined in XML format or JSON format. RESTful is suitable for scenarios where mobile Internet service providers are used as 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 Cloud provides interface services to external developers with a RESTful API.
Message queue The message queue refers to the container in which messages are stored during transmission.
Pulsar Pulsar is a multi-tenant, 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 various event data to external partners through Pulsar. Pulsar SDK provided by Tuya can complete message access and meet the requirements 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 in the cloud development section of Tuya IoT Console, accessId and accessKey are generated by default in the background. They are used for authorization authentication and interface authentication.
Standardization Standardization means that in the process of product connection, regarding repetitive control protocols and concepts, combined with categories, Tuya Cloud has unified object models, and formulated unified control protocols. Through one product connection on Tuya platform, developers can control products of multiple models in the same category. Reduce the complicated workload caused by repeated connection, thereby improving efficiency.
Command set One or more sets of control commands used to control the devices. It is distinguished by product categories. The command set under the same category includes the command set collections under different PIDs of the category. That is, the command set of the PID dimension is a subset of the command set of the category dimension.
Status set 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 the category. That is, the status set of the PID dimension is a subset of the status set of the category dimension. Note: There is no strict one-to-one correspondence between the command set and the status set. Developers can use the command set or status set as needed based on the sending and reporting scenarios.
schema The unique identification of an app, used for user data isolation on Tuya Cloud Platform. It is used in scenarios such as synchronizing users and querying users in cloud-to-cloud connection.
Click for services and help