plus

--- metadata: - name: generator content: Diplodoc Platform v5.48.2 alternate: - https://yandex.ru/dev/dialogs/smart-home/doc/en/start.md - https://yandex.ru/dev/dialogs/smart-home/doc/ru/start.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/dialogs/smart-home/doc/en/llms.txt # Creation and settings {% note alert %} For branded skills, use shared corporate accounts instead of personal employee accounts. Verify the accounts' rights to the site in [Yandex Webmaster](https://webmaster.yandex.com/site/settings/access/). {% endnote %} Check out the [smart home management concept](https://yandex.ru/dev/dialogs/smart-home/doc/en/concepts/general-concept.md). To create a skill, open the [developer console](https://dialogs.yandex.ru/developer/) and click **Создать диалог** → **Умный дом** (Create dialog → Smart home). Open the **Настройки** (Settings) tab and fill in the required fields. ## Language and description {#languages} For a skill to pass moderation, all settings (name, description, icon, and so on) should comply with formal requirements. #### Language The language of the skill, which determines which country your skill can be published in. The name, description, and subtitle should be written in this language. #### Name The name of the skill that will show up in the [Skill store](https://dialogs.yandex.ru/store/categories/smart_home). Name requirements: - Consists of at least two words excluding prepositions (we recommend using no more than four words). One word is acceptable if it is a unique brand name. - The same name doesn't already exist in the store. - It doesn't match a general category of products, services, or content (for example, “plastic windows”). - It doesn't contain the words “Smart home”, “Alice”, “Yandex”, or “Station”. #### Subtitle A brief description of the skill for the list of smart home skills in the [ Home with Alice](https://alice.yandex.ru/smart-home) app. #### Description Description of the skill that will appear in the [Skill store](https://dialogs.yandex.ru/store/categories/smart_home) and Home with Alice app. The final description is generated from the following fields: - **Подключение устройств** (Devices Connection): A pre-filled text field with placeholders that the skill author needs to fill in. - **URL поддержки** (Devices Connection) (for [official skills](https://yandex.ru/dev/dialogs/smart-home/doc/en/index.md#about-trusted-skills) only). You need to add your own description for each language. You can use the Markdown markup language features in the description: - Headers: ``` # Level one ## Level two ### Level three ``` - Quotes: ``` > Text > to pay attention to. ``` - Lists: ``` * bulleted * list 1. numbered 2. list ``` #### Additional language Click the **Добавить язык** (Add language) button to make the skill description available in another language. Also provide the name, subtitle, and description in the additional language. If you don't provide a description in the specified language, the first language from the list is used. ## Regions and countries {#countries} Locations that your skill supports. {% note alert "Limitation" %} If you use different handlers for different countries, you need to create multiple skills because you can only specify one **Backend URL** for one skill. {% endnote %} All countries where the skill is supported are automatically selected on the **Все доступные** (All available) tab depending on the specified languages. You can edit the list on the **Свой выбор** (Manual selection) tab by deselecting the countries the skill shouldn't be published in. For a country to become selectable, you need to use at least one of the languages of that country for your skill. ## Main settings {#general-settings} #### Backend {#backend} The parameters of the skill handler that accepts the user's requests via Yandex Dialogs and responds to them. {% note alert %} The skill response waiting time is 3 seconds. If Yandex Smart Home gets no response within this time, Alice alerts the user that devices aren't responding for a long time. If you manage devices in **Smart Home** → **Devices**, the user will see an error message and the request ID. This 3-second interval includes: - Setting up a network connection. - The time needed to deliver the request to the skill's server. - The time needed to execute the skill. - The time needed to deliver the response to Alice's servers. {% endnote %} {% note alert %} The response length must not exceed 5000 characters, the length of the OAuth token or refresh token must not exceed 2048 characters. Token lifetime (the `expires_in` property) must be an integer between 1 and 4,294,967,296. {% endnote %} Available options: - **Endpoint URL**: The URL of the skill handler. The handler must run on HTTPS, and the address must specify the protocol, for example `https://example.com/smart-home/`. For the skill to run correctly, set up the SSL certificate chain on the web server or in the provider service: 1. Generate a certificate using one of the certificate programs (such as [Let's Encrypt](https://letsencrypt.org/), [SSL For Free](https://www.sslforfree.com/), [CAcert](http://www.cacert.org/)). 2. Copy the certificate files to the folder. 3. Specify the paths to these files for your web server. {% note alert %} The platform only supports fullchain certificates. If you try to verify with a self-signed certificate, you will receive the following message: “Endpoint URL: Invalid SSL certificate". {% endnote %} To check the validity of the certificate, use the following online services: [SSL Labs](https://www.ssllabs.com/ssltest/analyze.html), [SSL Shopper](https://www.sslshopper.com/ssl-checker.html), [Wormly](https://www.wormly.com/test_ssl), [ImmuniWeb](https://www.immuniweb.com/ssl/). Keep in mind that online methods of generating and verifying certificates should not be used for sensitive data, because that way your private keys might leak to third-party services. - **Yandex Cloud function**: The ID of the [function in Yandex Cloud](https://yandex.ru/dev/dialogs/alice/doc/deploy-ycloud-function-docpage/). The function must be created by the skill author. For more information about creating and enabling a function for an Alice skill, see the [Yandex Cloud documentation](https://yandex.cloud/en/docs/functions/tutorials/alice-skill). #### Access type {#access-type} There are two types of access to a published skill: - **Public**: The skill will be published in the Skill store and seen by all Alice users. - **Private**: The skill is only available to you (in all surfaces where you're logged in as a skill creator). Private skills don't go through moderation and are published immediately. You can give Yandex users individual access to a private skill. For more information about private skills, see [Skill access](https://yandex.ru/dev/dialogs/smart-home/doc/en/access.md). Once published, the private skill will appear in the [ Home with Alice](https://alice.yandex.ru/smart-home) app. Open the Home with Alice app. In the top right-hand corner, tap and select **Устройство умного дома** (Smart home device). You'll find the skill in the list of popular manufacturers. ## Publication in the Skill store {#publishing} #### Developer's name Skill author's name. #### Developer's email Address for contacting the skill developer (the default is the Yandex.Mail account used to sign in to Yandex Dialogs). #### Official skill Indicates that it's an official brand skill, and the developer is a device manufacturer or the official representative of the manufacturer. #### Website for verifying the rights to use the brand Website address for the skill. It will be displayed on the skill description page in the [Skill store](https://dialogs.yandex.ru/store/categories/smart_home), under **Contact developers**. If you fill out this field, the skill will only pass moderation when you [verify your rights](https://yandex.ru/support/webmaster/service/rights.html?lang=en) to the site in [Yandex Webmaster](https://webmaster.yandex.com/welcome/). We'll make sure that you own the rights to the brand. Only you can use your brand and official website for your skill. #### Notes for the moderator Provide testing information: - Test account to verify skill authorization. - Devices needed for the skill to work. The Dialogs team will ask for these devices from you during verification. #### Icon The image to appear in the [Skill store](https://dialogs.yandex.ru/store/categories/smart_home). Icon requirements: - Format: PNG or JPG. - Size: 224 × 224 pixels or more. The image size will be reduced automatically if necessary. - The icon can feature the brand name or logo specified in the skill name and description. ## Supported devices {#devices} #### Product ID or name Go to the **Устройства** (Devices) tab. Start typing the device name and select it from the drop-down list or enter the device ID from a Yandex Market link. {% cut "Example of device ID from a link" %} - Yandex Market link: `https://market.yandex.ru/product--xiaomi-mi-led-smart-bulb/634589866` - Device ID: `634589866` {% endcut %} You need to fill in this field to be able to [certify devices](https://yandex.ru/dev/dialogs/smart-home/doc/en/certification.md) when creating official skills. ## Frequently asked questions {#troubleshooting} {% cut "Why isn't the skill responding to the user?" %} The waiting time for a response from the skill is three seconds. If Yandex Dialogs doesn't get a response within three seconds, the session ends. Alice tells the user that the skill is not responding. {% endcut %} {% cut "Can I move a skill from one account to another?" %} Yes Write to [support](https://yandex.ru/dev/dialogs/alice/doc/feedback.html). The skill will be moved within two weeks. To avoid moving branded skills from your employees' personal accounts, create such skills from corporate accounts. {% endcut %} {% cut "What steps of request processing go into these three seconds?" %} This three-second interval includes the following steps: 1. Setting up a network connection. 1. Sending a request over the network from the Yandex Dialogs server to the skill server. 1. Generating a response. 1. Sending a response over the network from the skill server back to the Yandex Dialogs server. {% endcut %}