Get Started with Alexa for Residential APIs

Prerequisites

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

To create an Amazon Business account

To register with Alexa for Residential

  • To register your Amazon Business account for Alexa for Residential APIs, see Get Started with Alexa for Hospitality and Alexa for Residential. A member of the Alexa Business Development team will contact you to:
    • Register your company's Amazon Business account e-mail or customer ID, legal entity ID, and app client ID
    • Finalize pricing
    • Finish setting up your subscription
    • Give you your Alexa for Residential organization (amzn1.alexa.unit.did.{id}) identifier

Create an LWA security profile

Create a security profile by following the steps in the LWA console. 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.

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 information, see Authorization Code Grant.

To integrate with LWA to get an API access token for Alexa for Residential

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

After you can successfully log in with Amazon by using your Amazon Business account, you can call Alexa for Residential 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 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 for Residential, you're ready to use its APIs. To learn how to set up admin roles for your users, see Managing Roles in Alexa for Residential.