AmazonClient Class

Nemiro.OAuth

OAuth client for Amazon.

Inheritance Hierarchy

System Object
  Nemiro.OAuth OAuthBase
    Nemiro.OAuth OAuth2Client
      Nemiro.OAuth.Clients AmazonClient

Namespace: Nemiro.OAuth.Clients
Assembly: Nemiro.OAuth (in Nemiro.OAuth.dll) Version: 1.9.4.725 (1.9.4.725)

Syntax

public class AmazonClient : OAuth2Client

public class AmazonClient : OAuth2Client

Public Class AmazonClient 
	Inherits OAuth2Client

Public Class AmazonClient 
	Inherits OAuth2Client

The AmazonClient type exposes the following members.

Constructors

	Name	Description
	AmazonClient	Initializes a new instance of the AmazonClient class.

Top

Methods

	Name	Description
	Clone	Creates a shallow copy of the current object. (Inherited from OAuthBase.)
	Clone(NameValueCollection, String)	Creates a shallow copy of the current object. (Inherited from OAuthBase.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetAccessToken	Gets the access token from the remote server. (Inherited from OAuth2Client.)
	GetHashCode	(Inherited from Object.)
	GetSpecifiedTokenOrCurrent	Returns the specified access token or the current access token. (Inherited from OAuthBase.)
	GetType	(Inherited from Object.)
	GetUserInfo	Obsolete. Gets the user details via API of the provider. (Inherited from OAuthBase.)
	GetUserInfo(AccessToken)	Gets the user details. (Overrides OAuthBase GetUserInfo(AccessToken).)
	MemberwiseClone	(Inherited from Object.)
	RedirectToAuthorization	Redirects a client to the Authorization URL. (Inherited from OAuthBase.)
	RefreshToken	Sends a request to refresh the access token. (Overrides OAuth2Client RefreshToken(AccessToken).)
	RevokeToken	Sends a request to revoke the access token. (Inherited from OAuthBase.)
	ToString	(Inherited from Object.)

Top

Properties

	Name	Description
	AccessToken	Gets or sets an access token. (Inherited from OAuthBase.)
	AccessTokenUrl	Gets or sets the address for the access token. (Inherited from OAuthBase.)
	AccessTokenValue	Gets an access token value. (Inherited from OAuthBase.)
	ApplicationId	Gets or sets the application identifier. (Inherited from OAuthBase.)
	ApplicationSecret	Gets or sets the application secret key. (Inherited from OAuthBase.)
	AuthorizationCode	Gets or sets access code for access token requests. (Inherited from OAuthBase.)
	AuthorizationUrl	Gets the endpoint of the authorization. (Inherited from OAuth2Client.)
	AuthorizeUrl	Gets or sets the base address for login. (Inherited from OAuthBase.)
	DefaultScope	The deault scope. (Inherited from OAuth2Client.)
	GrantType	Gets or sets grant type. (Inherited from OAuth2Client.)
	Parameters	Gets or sets additional query parameters. (Inherited from OAuthBase.)
	Password	Gets or sets password if GrantType is password or client_credentials. (Inherited from OAuth2Client.)
	ProviderName	Unique provider name: Amazon. (Overrides OAuthBase ProviderName.)
	ReturnUrl	Gets or sets return URL. (Inherited from OAuthBase.)
	Scope	The scope of the access request. (Inherited from OAuth2Client.)
	ScopeSeparator	The separator in the scope list. (Inherited from OAuth2Client.)
	State	Gets or sets unique request identifier. For clients the value sets is automatically. (Inherited from OAuthBase.)
	SupportRefreshToken	Gets or sets a value indicating whether the current client supports refreshing access token. (Inherited from OAuthBase.)
	SupportRevokeToken	Gets or sets a value indicating whether the current client supports revoking access token. (Inherited from OAuthBase.)
	Username	Gets or sets username if GrantType is password or client_credentials. (Inherited from OAuth2Client.)
	Version	Gets the version of the OAuth protocol. (Inherited from OAuthBase.)

Top

Remarks

Register and Configure Amazon Application

Web Management Interface may change over time. Applications registration shown below may differ.
If the interface is changed, you need to register the application and get Client ID and Client Secret. For web projects, configure return URLs.
If you have any problems with this, please visit issues. If you do not find a solution to your problem, you can create a new question.

You need to register as developer in the App Console.

In the App Console register new application.

Specify one or more return URLs. Access to any other address will be denied.

NOTE: Amazon supports only addresses over HTTPS (excluding localhost).

For example:

https://hamster.example.org/Home/ExternalLoginResult
http://localhost:59962/Home/ExternalLoginResult
http://localhost/

Allowed Return URLs

Do not forget to save your changes.

Use application Client ID and Client Secret when creating an instance of the AmazonClient class.

Allowed Return URLs

C++

Copy to Clipboard Print

OAuthManager.RegisterClient
(
  new AmazonClient
  (
    "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
    "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
  )
);

OAuthManager.RegisterClient
(
  new AmazonClient
  (
    "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
    "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
  )
);

OAuthManager.RegisterClient _
(
  New AmazonClient _
  (
    "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
    "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
  )
)

OAuthManager.RegisterClient _
(
  New AmazonClient _
  (
    "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
    "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
  )
)

For more details, please see Amazon Developer Documentation.

Examples

The following example shows how to add the Amazon OAuth Client to ASP .NET MVC Application.

In the Application_Start event handler (Global.asax file) is registered the AmazonClient.

C++

Copy to Clipboard Print

protected void Application_Start()
{
  OAuthManager.RegisterClient
  (
    new AmazonClient
    (
      "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
      "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
    )
  );
}

protected void Application_Start()
{
  OAuthManager.RegisterClient
  (
    new AmazonClient
    (
      "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
      "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
    )
  );
}

Sub Application_Start()
  OAuthManager.RegisterClient _
  (
    New AmazonClient _
    (
      "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
      "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
    )
  )
End Sub

Sub Application_Start()
  OAuthManager.RegisterClient _
  (
    New AmazonClient _
    (
      "amzn1.application-oa2-client.f0ffe4edc256488dae00dcaf96d75d1b", 
      "764dcefe49b441c8c6244c93e5d5d04de54fda6dfdc83da9693bf346f4dc4515"
    )
  )
End Sub

The ExternalLoginResult method will handle authorization result.

C++

Copy to Clipboard Print

public ActionResult ExternalLoginResult()
{
  var result = OAuthWeb.VerifyAuthorization();
  if (result.IsSuccessfully)
  {
    var user = result.UserInfo;    
    // NOTE: For StringBuilder import the System.Text
    StringBuilder r = new StringBuilder();
    r.AppendFormat("User ID: {0}\r\n", user.UserId);
    r.AppendFormat("Name:    {0}\r\n", user.DisplayName);
    r.AppendFormat("Email:   {0}", user.Email);
    return new ContentResult { Content = r.ToString(), ContentType = "text/plain" }; 
  }

  return new ContentResult 
  { 
    Content = "Error: " + result.ErrorInfo.Message, 
    ContentType = "text/plain" 
  };
}

public ActionResult ExternalLoginResult()
{
  var result = OAuthWeb.VerifyAuthorization();
  if (result.IsSuccessfully)
  {
    var user = result.UserInfo;    
    // NOTE: For StringBuilder import the System.Text
    StringBuilder r = new StringBuilder();
    r.AppendFormat("User ID: {0}\r\n", user.UserId);
    r.AppendFormat("Name:    {0}\r\n", user.DisplayName);
    r.AppendFormat("Email:   {0}", user.Email);
    return new ContentResult { Content = r.ToString(), ContentType = "text/plain" }; 
  }

  return new ContentResult 
  { 
    Content = "Error: " + result.ErrorInfo.Message, 
    ContentType = "text/plain" 
  };
}

Public Function ExternalLoginResult() As ActionResult
  Dim result As AuthorizationResult = OAuthWeb.VerifyAuthorization()
  If result.IsSuccessfully Then 
    Dim user As UserInfo = result.UserInfo   
    ' NOTE: For StringBuilder import the System.Text 
    Dim r As New StringBuilder()
    r.AppendFormat("User ID: {0}", user.UserId)
    r.AppendLine()
    r.AppendFormat("Name:    {0}", user.DisplayName)
    r.AppendLine()
    r.AppendFormat("Email:   {0}", user.Email)
    Return New ContentResult With { .Content = r.ToString(), .ContentType = "text/plain" } 
  End If 

  Return New ContentResult With _
  { 
    .Content = "Error: " + result.ErrorInfo.Message, 
    .ContentType = "text/plain" 
  }
End Function

Public Function ExternalLoginResult() As ActionResult
  Dim result As AuthorizationResult = OAuthWeb.VerifyAuthorization()
  If result.IsSuccessfully Then 
    Dim user As UserInfo = result.UserInfo   
    ' NOTE: For StringBuilder import the System.Text 
    Dim r As New StringBuilder()
    r.AppendFormat("User ID: {0}", user.UserId)
    r.AppendLine()
    r.AppendFormat("Name:    {0}", user.DisplayName)
    r.AppendLine()
    r.AppendFormat("Email:   {0}", user.Email)
    Return New ContentResult With { .Content = r.ToString(), .ContentType = "text/plain" } 
  End If 

  Return New ContentResult With _
  { 
    .Content = "Error: " + result.ErrorInfo.Message, 
    .ContentType = "text/plain" 
  }
End Function

Now you can easily redirect user to login page.

C++

Copy to Clipboard Print

// NOTE: use httpS scheme for real websites 
string authUrl = OAuthWeb.GetAuthorizationUrl("Amazon", Url.Action("ExternalLoginResult", "Home", null, null, Request.Url.Host));
// for example, MVC redirection from Action: 
// return Redirect(authUrl);

// NOTE: use httpS scheme for real websites 
string authUrl = OAuthWeb.GetAuthorizationUrl("Amazon", Url.Action("ExternalLoginResult", "Home", null, null, Request.Url.Host));
// for example, MVC redirection from Action: 
// return Redirect(authUrl);

' NOTE: use httpS scheme for real websites 
Dim authUrl As String = OAuthWeb.GetAuthorizationUrl("Amazon", Url.Action("ExternalLoginResult", "Home", Nothing, Nothing, Request.Url.Host))
' for example, MVC redirection from Action 
' Return Redirect(authUrl)

' NOTE: use httpS scheme for real websites 
Dim authUrl As String = OAuthWeb.GetAuthorizationUrl("Amazon", Url.Action("ExternalLoginResult", "Home", Nothing, Nothing, Request.Url.Host))
' for example, MVC redirection from Action 
' Return Redirect(authUrl)

Result shown in the images below.

Amazon Sign in

Amazon User Info