Embarking on the journey of software program improvement is exhilarating, however everyone knows that the trail from code to a flawless person expertise will be difficult. That is why we have been laborious at work constructing an answer so that you can take management of your Cloud Related Gadget’s future earlier than it launches to thousands and thousands of SmartThings customers around the globe.
SmartThings Schema is the quickest technique of integrating your Cloud Related Gadget with SmartThings. With our new invites function, you may share your SmartThings Schema integration to quickly check and iterate your integration throughout your environments while not having to publish it to the SmartThings catalog. When you’re able to distribute your integration within the SmartThings app, merely submit your integration for Works with SmartThings (WWST) certification utilizing the Certification Console.
Learn on to be taught extra in regards to the course of for creating and managing a SmartThings Schema invitation.
- An current SmartThings Schema integration: in the event you haven’t created a SmartThings Schema integration but, find out how on our developer documentation portal.
- The newest model of the SmartThings Command Line Interface (CLI) put in and signed in utilizing the Samsung account related along with your SmartThings Schema integration.
When working the CLI for the primary time, the CLI prompts for entry to your Samsung account.
1. Creating Your Invitation
Get began with an interactive session within the SmartThings CLI. The CLI lists all Schema integrations related along with your SmartThings account and walks you thru the invitation creation course of.
$ smartthings invitations:schema:create
The CLI prompts you to pick an current app and asks you to supply the next parameters:
- Description (non-compulsory): Your description is exhibited to customers when viewing the Settle for URL
- Settle for Restrict (non-compulsory): Restrict the variety of installations. If you don’t specify a restrict, your invitation is restricted to a most of 500 installs.
After creating your invitation, you’ll be given an `Settle for URL` within the response. Share this URL along with your beta testers. Anybody with this URL and a SmartThings account can set up your SmartThings Schema integration. Your invitation is legitimate for 30 days.
WarningYour Schema integration will be put in by anybody with the
Settle for URL.
2. Sharing Your Invitation
After creating your invitation, you’re able to share your
Settle for URL and invite others to check your integration. When a person accesses your
Settle for URL, they are going to be directed to a touchdown web page along with your Schema integration brand, assist e mail, and outline as outlined whenever you initially created your Schema integration. The person will likely be prompted to pick a Location related to their SmartThings account and authorize SmartThings to entry your Schema integration.
After a person installs your Schema integration, they are going to be directed to https://my.smartthings.com, and may now use your Schema integration within the SmartThings app. Beneath, you may see a pattern touchdown web page for a Schema invitation.
3. Managing your Invites
smartthings invitations:schema command shows your invites, the variety of acceptances, and when your invitation will expire.
TipYou possibly can retrieve the
Settle for URL for an invite with
smartthings invitations:schema [invitation id]
Invites routinely expire after 30 days. After your invitation expires, new customers will not be permitted to affix your integration with the related
Settle for URL. Present customers of your integration will not be affected when an invite expires and will proceed to make use of your integration whereas it’s put in on their SmartThings account. A brand new invitation will be generated at any time.
As you iterate and proceed to develop your Schema integration, current customers of your integration will routinely make the most of your up to date integration — no motion is required on both your or your customers’ half.
At any time, you should use
smartthings invitations:schema:delete to shut down your invitation. Once you delete an invite or an invite expires, current customers of your Schema integration is not going to be affected.
stateCallback with the SmartThings Schema
globalError.errorEnum: INTEGRATION-DELETED. The
globalError will also be supplied in a Schema response. For extra data, see SmartThings Schema Interaction Types
The introduction of Invites for Schema function is a big enchancment for builders integrating their Cloud Related Gadgets. Now you may quickly check, iterate, and excellent your integration with a number of beta customers, all earlier than publishing your system to the SmartThings catalog.
Once you’re able to make your integration obtainable within the SmartThings catalog, it’s time to get Works with SmartThings Licensed. As soon as full, you may publish your Schema integration within the SmartThings app to be used by thousands and thousands of SmartThings customers. Go to https://developer.smartthings.com/docs/certification/overview to be taught extra about the advantages of Works with SmartThings Certification.