Get Started with Alexa Smart Properties for Hospitality APIs

Note: Sign in to the developer console to build or publish your skill.

Before you can use Alexa Smart Properties for hospitality APIs, you must create a local Amazon Business account, and then register it with Alexa Smart Properties for hospitality. Then you must create a Login with Amazon (LWA) security profile by using the same Amazon Business account that you registered with Alexa Smart Properties for hospitality. Finally, you must register your LWA security profile with Alexa Smart Properties and use the security profile to generate an API access token.

Important: You must create an Amazon Business account in each marketplace where your properties are located. For example, if you have properties in the US, UK, and FR marketplaces, you must create local Amazon Business accounts in amazon.com, amazon.co.uk, and amazon.fr and use each account to sign up for Alexa Smart Properties for hospitality and manage devices in the corresponding marketplace.

Prerequisites

To create an Amazon Business account

To create an Amazon Business account, follow Step 1 in the Get started with Alexa Smart Properties for hospitality self-guided checklist.
Note: It takes one to two days for your account to be validated and to gain access through Amazon Business. To verify the business account, make sure you have official documents that contain your EIN, or sole proprietor, or individual status.

To register with Alexa Smart Properties for hospitality

If you're already working with a member of the Alexa Smart Properties Business Development team, inform them that you've completed the previous steps, and they'll complete your setup.
If you're not working with a member of the Business Development team, see Get Started with Alexa Smart Properties for hospitality and Alexa Smart Properties for residential. A member of the Business Development team will contact you to:
- Register your company's Amazon Business account email or customer ID and business ID
  Note: To find your business ID, log in to your Amazon business account, and then navigate to your account settings.
- Finalize pricing
- Finish setting up your subscription

Create an LWA security profile

Create a security profile by following the steps in the LWA console, using the same Amazon Business account and email address that you registered with Alexa Smart Properties for hospitality. For future reference, make sure to note the client ID for your application. After creating your security profile, add your website to the security profile.

Important: When you create your LWA security profile, you must use the same Amazon Business account and email address that you registered with Alexa Smart Properties for hospitality.

Register your LWA security profile and obtain your Organization ID

Log into the Alexa Smart Properties Console and go to Administration. Click Grant API Access, enter your LWA Client ID, and then click Submit to register your LWA security profile and obtain your Alexa Smart Properties for hospitality organization (amzn1.alexa.unit.did.{id}) identifier.

Integrate with LWA to get an API access token

To integrate LWA into your application to obtain an API access token, follow the instructions in Integrate LWA with your app. These instructions show you how to integrate LWA into your application and obtain an LWA API access token. For more details, see Authorization Code Grant.

To integrate with LWA to get an API access token for Alexa Smart Properties for hospitality

Choose Auth Code Grant as your auth grant type.
Request the "alexa::enterprise:management", "credential_locker::wifi_management", and "profile:user_id" scopes.

After you can successfully log in with LWA by using your Amazon Business account, you can call Alexa Smart Properties for hospitality APIs.

To refresh your access token, follow the instructions in Using Refresh Tokens.

Use the LWA access token

To call the APIs, you must include your API access token as part of the Authorization request header of each API call.

The following example is a CURL request that uses the access token to call the endpoint enumeration API. To use it, change $ACCESS_TOKEN to your real access token, and then change the URL to the correct one for the API you're calling.

   curl -i -v -X GET -H "Authorization: Bearer $ACCESS_TOKEN" https://api.amazonalexa.com/v2/endpoints

Now that you've registered with Alexa Smart Properties for hospitality, you're ready to use its APIs.

Last updated: Dec 15, 2022