English
English
简体中文
Contact Us
Register
Log In
layoutIndex

Custom Domain Name

Last Updated on : 2022-08-15 19:43:45download

What is Custom Domain Name?

An IoT app and respective smart devices in service initiate network requests to access a certain domain name for data transmission. Currently, the apps developed based on Tuya’s OEM App and App SDK services are built with the domain names provided by Tuya.

To configure a custom domain name for your app, you can subscribe to Tuya’s Custom Domain Name service. After a custom domain name is configured and becomes effective, rebuild your app and pair smart devices with the app. Then, the network requests initiated by the app and newly-paired devices will be processed through the custom domain name. This helps improve the uniqueness of your app services. If you plan to migrate to a private cloud, the migration will be simplified when a custom domain name is used. In this case, associated smart devices do not need to be paired again.

How a custom domain name takes effect

App settings

When you configure a custom domain name, set an active starting app version. After the custom domain name is configured, rebuild the app with the specified active starting version or later. Then, the custom domain name becomes effective. If the app is built before the custom domain name becomes effective, the app still runs with the default domain name.

The custom domain name applies to main pages and features of the app. However, for historical features, specific third-party pages, and URLs configured on your own, or in other special conditions, the domain name might fail to take effect. In this case, you can contact Tuya’s Customer Services team to request technical support.

The Custom Domain Name service supports app template v4.1.0 and later only. If a custom domain name is configured for an app that is built with the template earlier than v4.1.0, this custom domain name might not take effect. You can check the template version information on the details page of your OEM app.

Custom Domain Name

Device settings

Pair associated smart devices again with the app that has a custom domain name newly configured. Otherwise, the custom domain name will not take effect for these smart devices. They will still access the default domain name to transmit data.

Impact on legacy versions

After the custom domain name is configured, your app and respective smart device in service will not make user-facing changes.

However, if the custom domain name is configured for your app that already has a default domain name in service, the default domain name will become unavailable. This is because the custom domain name cannot take effect for the launched app. As a result, users cannot access the app and respective smart devices as normal.

Validity period and expiration

The validity period of a custom domain name is calculated by years. You can check the validity period on the Custom Domain Name tab after the domain name is configured.

The fees for the service subscription and renewal are paid only on an annual basis. You must renew the subscription timely as specified in the rules on the use of custom domain names before your custom domain name expires.

Otherwise, the domain name will become ineffective. Thus, users cannot access the respective app and smart devices through the domain name as expected. Therefore, we recommend that you renew the subscription timely before the custom domain name expires to avoid preceding problems.

If you failed to timely renew the subscription, certain problems and responsibilities might be incurred, including but not limited to that the app is disabled, existing paired smart devices cannot be accessed or used, and end users initiate complaints and claims for compensation. In this case, all relevant responsibilities and liabilities will be undertaken by you. Tuya will not take any responsibilities.

Configure a custom domain name

Go to Tuya IoT Development Platform > OEM App, find Custom Domain Name in Step 3: Configure App, and then click Set to navigate to the Custom Domain Name tab.

Custom Domain Name

Continue with the following steps to configure a custom domain name:

Step 1: Read and accept Custom Domain Name Service Agreement

You must first carefully read and accept the Custom Domain Name Service Agreement. The specific content of the agreement is subject to that displayed on the platform.

Custom Domain Name

Step 2: Configure required information

  1. Select a domain name that you prefer. You can enter a keyword for the preferred domain name and choose one from the similar available domain names that appear. Currently, the top-level domain name can only be .net or .com.

  2. Confirm the active starting app version. This step is very important. We recommend that you specify an unused app version as the active starting app version. If the latest version has been launched, we recommend that you build a new version. Then, you can submit the settings.

    Custom Domain Name

Step 3: Wait for the notification of finished configuration

After the settings of the custom domain name are submitted, Tuya’s staff will help you register the specified domain name and finish required configurations. This process will take three to five working days in most cases. The successful registration and configuration result will be sent to you by email and SMS. Please wait with patience.

Custom Domain Name

Tuya will help to register your specified domain name. In certain special conditions, the domain name might fail to be registered. Then, Tuya will notify you by email and SMS of the registration failure. You can select another custom domain name and submit the settings again.

Custom Domain Name

Step 4: Renew subscription

Rebuild the app to make the configured custom domain name take effect. The custom domain name automatically applies to the subsequent new app versions without additional app configurations.

Custom Domain Name

You can check the validity period of the custom domain name on the Custom Domain Name tab and timely renew the subscription if needed.

If you failed to timely renew the subscription, the app and respective smart devices that are accessed through the custom domain name will not be accessed as normal. This will cause a serious impact on your business and your end users’ experience. For more information, see Validity period and expiration.

Tuya will notify you by email or SMS of timely renewal prior to the expiration.

Mapping between domain name and data center

After you select a preferred domain name during the configuration, the system automatically generates and configures the second-level domain name or third-level domain name required by different data centers and services. The custom domain name is configured in this format: Service prefix-Data center.Specified custom domain name.

For example, if you select the domain name: customdomain.com, the following custom domain names are generated for the respective data centers:

  • Western America Data Center: Service prefix-us.customdomain.com
  • Central Europe Data Center: Service prefix-eu.customdomain.com
  • India Data Center: Service prefix-in.customdomain.com

A service prefix is an identifier of a specific service and is subject to Tuya’s setting. You can ignore this setting.

Additional notes

  • App domain names targeted at users inside mainland China: If your app users cover those inside mainland China, the app domain name must first go through domain name filing. As a result, custom domain names are currently not supported. In this case, your app runs with the domain name provided by Tuya.
  • The Tuya IoT Development Platform currently does not support your existing domain name. If you have any questions, please contact Tuya’s Customer Services team.
  • The configured custom domain name applies to network requests initiated by your app and paired devices, respecting the main pages, features, and services. However, for the pages outside the app, historical features, specific third-party pages, and URLs configured on your own, or in other special conditions, the domain name might fail to take effect. In this case, you can contact Tuya’s Customer Services team to request technical support.