Authorize from a Companion App (Android/iOS)

Follow the instructions below to use LWA SDK for Android to pass a LWA authorization code to your product, which your product can then use to obtain refresh and access tokens needed to make calls to AVS.

• Register a device in the Amazon Developer Console and generate an API key for your product. For instructions on how to create an account and register a product see Getting Started with AVS.
• Navigate to Login with Amazon for Android Overview and follow the instructions on the page.
• Then complete the following steps to obtain an LWA access token to use with AVS:

1. Import the Login with Amazon API to your source file. To import the Login with Amazon API, add the following import statements to your source file:

   import com.amazon.identity.auth.device.AuthError;
   import com.amazon.identity.auth.device.api.authorization.AuthCancellation;
   import com.amazon.identity.auth.device.api.authorization.AuthorizationManager;
   import com.amazon.identity.auth.device.api.authorization.AuthorizeListener;
   import com.amazon.identity.auth.device.api.authorization.AuthorizeRequest;
   import com.amazon.identity.auth.device.api.authorization.AuthorizeResult;
   import com.amazon.identity.auth.device.api.authorization.ScopeFactory;
   import com.amazon.identity.auth.device.api.workflow.RequestContext;
   

2. Initialize the RequestContext.

   You will need to declare a RequestContext member variable and create a new instance of the class. To create the instance, pass in the current application context to the static factory method. The best place to initialize the RequestContext is in the onCreate method of your Activity. For example:

   private RequestContext mRequestContext;
   
   @Override
   protected void onCreate(Bundle savedInstance) {
       super.onCreate(savedInstance);
       mRequestContext = RequestContext.create(this);
   }
   

3. Create an AuthorizeListenerImpl.

   AuthorizeListenerImpl extends the AuthorizeListener abstract class and will process the result of the authorize call. It contains three methods: onSuccess, onError, and onCancel. The AuthorizeResult object passed into the onSuccess method will contain the values needed to obtain an authorization token.

   private class AuthorizeListenerImpl extends AuthorizeListener {
   
       /* Authorization was completed successfully. */
       @Override
       public void onSuccess(final AuthorizeResult authorizeResult) {
       }
   
       /* There was an error during the attempt to authorize the application. */
       @Override
       public void onError(final AuthError authError) {
       }
   
       /* Authorization was cancelled before it could be completed. */
       @Override
       public void onCancel(final AuthCancellation authCancellation) {
       }
   }
   

4. Create an instance of AuthorizeListenerImpl and register it.

   Create an instance of your AuthorizeListenerImpl and register it with your RequestContext instance. When the AuthorizeManager.authorize call is made, your RequestContext instance will invoke the appropriate callback method in your AuthorizeListener with the result of the authorize request. The best place to register your AuthorizeListenerImpl instance is in the onCreate method.

   @Override
   protected void onCreate(Bundle savedInstance) {
     super.onCreate(savedInstance);
     mRequestContext = RequestContext.create(this);
     mRequestContext.registerListener(new AuthorizeListenerImpl());
   }
   

5. Override the onResume method.

   Override the onResume method in your Activity. Call super.onResume() as well as the onResume method on your RequestContext instance. This will notify the RequestContext to invoke your AuthorizeListener when your app is resumed if there is a callback ready from your AuthorizeManager.authorize call.

   @Override
   protected void onResume() {
       super.onResume();
       mRequestContext.onResume();
   }
   

6. Call AuthorizeManager.authorize.

   In the onClick handler for your Login with Amazon button, call authorize to prompt the user to log in and authorize your application. This method is responsible for authorizing the customer in one of the following ways:

   • Switches to the system browser and lets the customer sign in and consent to the requested information.

   • Switches to web view in a secure context to let the customer sign in and consent to the requested information.


   This secure context for the second point above, is currently made available as the Amazon Shopping app on Android devices. Amazon devices running Fire OS (for example Kindle tablets and Fire TV devices) always use this option even if there is no Amazon Shopping app on the device. Because of this, if the customer is already signed in to the Amazon Shopping app, this API will skip the sign-in page, leading to a Single Sign On experience for the customer.

   When your application is authorized, it is authorized for one or more data sets known as scopes. Scopes are an OAuth mechanism for a client to tell an authorization server what resource permissions they need. You pass an array of scopes as a parameter to the authorize method.

   The first time a user logs in to your app, they will receive a prompt that contains the list of data you require access to, and request consent before proceeding. LWA when used with AVS requires the alexa:all scope. The alexa:voice_service:pre_auth scope enables the AVS Hosted Splash for the user.

   Important: To use AVS hosted splash, you must include the alexa:voice_service:pre_auth scope, and remove your existing splash screen. All new products are required to utilize the AVS hosted splash scope.

   The call to authorize is asynchronous, and your AuthorizeListenerImpl instance will be invoked with the result of your call.

   private RequestContext mRequestContext;
   private static final String PRODUCT_ID = "INSERT YOUR PRODUCT ID FROM AMAZON DEVELOPER CONSOLE";
   private static final String PRODUCT_DSN = "INSERT UNIQUE DSN FOR YOUR DEVICE";
   private static final String CODE_CHALLENGE = "INSERT CODE CHALLENGE FROM DEVICE FOR THIS REQUEST";
   private static final String CODE_CHALLENGE_METHOD = "S256";
   
   @Override
   protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       mRequestContext = RequestContext.create(this);
       mRequestContext.registerListener(new AuthorizeListenerImpl());
   
       // Find the button with the login_with_amazon ID
       // and set up a click handler
       mLoginButton = (Button) findViewById(R.id.login_with_amazon);
       mLoginButton.setOnClickListener(new OnClickListener() {
           @Override
           public void onClick(View v) {
               final JSONObject scopeData = new JSONObject();
               final JSONObject productInstanceAttributes = new JSONObject();
   
               try {
                   productInstanceAttributes.put("deviceSerialNumber", PRODUCT_DSN);
                   scopeData.put("productInstanceAttributes", productInstanceAttributes);
                   scopeData.put("productID", PRODUCT_ID);
   
                   AuthorizationManager.authorize(new AuthorizeRequest.Builder(mRequestContext)
                       .addScopes(ScopeFactory.scopeNamed("alexa:voice_service:pre_auth"),
                               ScopeFactory.scopeNamed("alexa:all", scopeData))
                       .forGrantType(AuthorizeRequest.GrantType.AUTHORIZATION_CODE)
                       .withProofKeyParameters(CODE_CHALLENGE, CODE_CHALLENGE_METHOD)
                       .build());
               } catch (JSONException e) {
                   // handle exception here
               }
           }
       });
   }
   

   In the code above we are adding the following options:

   • scopeData is extra data that includes the product type ID (PRODUCT_ID) and the product’s unique DSN (PRODUCT_DSN), that is bound to the alexa:all scope.
   • A constant which specifies that the authorization code should be returned.
   • The code challenge. For Base64 URL encoding we recommend using Android’s Base64 library with the following flags: Base64.NO_PADDING, Base64.URL_SAFE, and Base64.NO_WRAP.
   • The code challenge’s encoding method (S256).

   The authorization code you’ve obtained is valid for 5 minutes and a single use.

7. Implement onSuccess for your AuthorizeListenerImpl.

   Retrieve the authorization code, redirect URI, and client id from the AuthorizeResult to be sent securely to your product.

   private class AuthorizeListenerImpl extends AuthorizeListener {
       @Override
       public void onSuccess(final AuthorizeResult authorizeResult) {
           final String authorizationCode = authorizeResult.getAuthorizationCode();
           final String redirectUri = authorizeResult.getRedirectUri();
           final String clientId = authorizeResult.getClientId();
           // Securely send the authorization code, redirectUri, and clientId to the product
       }
       // …
       // Other methods from AuthorizeListener
   }
   

8. Once the authorization code, client ID, and redirect URI are received on the product, the product should call LWA in order to exchange the authorization code for access and refresh tokens. When making the call, the product needs to send a POST request to https://api.amazon.com/auth/O2/token and pass in the following parameters:

   • grant_type: authorization_code
   • code: The authorization code received from the Android app.
   • redirect_uri: The redirect URI received from the Android app.
   • client_id: The client ID received from the Android app.
   • code_verifier: The code verifier that was initially generated by the product.

   The response includes the following values:

   • access_token: The access token.
   • refresh_token: The refresh token.
   • token_type: bearer
   • expires_in: The number of seconds for which the access token is still valid.

9. When the access token has expired or is about to expire, the refresh token can be exchanged for new access and refresh tokens. A new connection to AVS should only be made after the tokens have been successfully received and updated. If the token exchange fails, your client is expected to retry with an exponential back-off. To do the exchange, POST to https://api.amazon.com/auth/O2/token with the following parameters:

   • grant_type: refresh_token
   • refresh_token: The refresh token.
   • client_id: The client ID received from the Android app.

   The response includes the following values:

   • access_token: The access token.
   • refresh_token: The refresh token.
   • token_type: bearer
   • expires_in: The number of seconds for which the access token is still valid.