AmzSpApi 0.0.5

AmazonSpAPI

AmazonSpAPI is a c# library organize and generate SP-API request.

Installation

Build the project AmzSpAPi and find assembly file AmzSpApi.dll with your project.

Getting Started

Before you can use the client you need to add your app client and aws user credentials.

Setting credentials from configuration file

Add these setting in configuration file.

• <add key="SELLING_PARTNER_APP_CLIENT_ID" value="<YOUR_APP_CLIENT_ID>" />
• <add key="SELLING_PARTNER_APP_CLIENT_SECRET" value="<YOUR_APP_CLIENT_ID>" />
• <add key="AWS_ACCESS_KEY_ID " value="<YOUR_APP_CLIENT_ID>" />
• <add key="AWS_SECRET_ACCESS_KEY " value="<YOUR_APP_CLIENT_ID>" />
• <add key="AWS_SELLING_PARTNER_ROLE" value="<YOUR_APP_CLIENT_ID>" />

var config = new Config()
{
    Region = SpApiRegion.FarEast,
    RefreshToken = "<Refresh Token>",
    Options = new Options()
    {
        OnlyGrantlessOperations = false,
        UseConfigurationCredential = true
    }
};

var api = new SellingPartnerApi(config);

Setting credentials from configuration object

var config = new Config()
            {
                Region = SpApiRegion.FarEast,
                RefreshToken = "<Refresh Token>",
                Credentials = new Credentials()
                {
                    AppClient = new AppClient()
                    {
                        Id = "<LWA client id>",
                        Secret = "<LWA client secret>",
                    },
                    AwsUser = new AwsUser()
                    {
                        Id = "<Aww User Id>",
                        SecretKey = "<Aws User Secret Key>",
                        Role = "<Aws User Role Arn>"
                    },
                },
                Options = new Options()
                {
                    OnlyGrantlessOperations = false,
                }
            };

Config params

{
  Region='<REGION>',
  RefreshTToken='<REFRESH_TOKEN>',
  AccessToken='<ACCESS_TOKEN>',
  RoleCredentials:{
    Id='<TEMPORARY_ROLE_ACCESS_ID>',
    Secret='<TEMPORARY_ROLE_ACCESS_SECRET>',
    SecurityToken='<TEMPORARY_ROLE_SECURITY_TOKEN>'
  },
  Credentials:{
    AppClient:{
        Id="<APP_CLIENT_ID>",
        Secret= "<APP_CLIENT_SECRET>" 
    },
    AwsUser = {
        Id = "<AWS_USER_ID>",
        Secret = "<AWS_USER_SECRET>",
        UserRole = "<AWS_SELLING_PARTNER_API_ROLE>"
    }
  },
  Options:{
    UseConfigurationCredential = true
    UseSandbox:false,
    OnlyGrantlessOperations:false
  }
}

Valid properties of the config object:

Valid properties of the config options:

Usage

Config api client

You have to provide these information.

var config = new Config()
            {
                Region = SpApiRegion.FarEast,
                RefreshToken = "<SellerRefreshToken>",
                Credentials = new Credentials()
                {
                    AppClient = new AppClient()
                    {
                        Id = "<LWA client id>",
                        Secret = "<LWA client secret>",
                    },
                    AwsUser = new AwsUser()
                    {
                        Id = "<Aww User Id>",
                        SecretKey = "<Aws User Secret Key>",
                        Role = "<Aws User Role Arn>"
                    },
                },
                Options = new Options()
                {
                    OnlyGrantlessOperations = false,
                    // if true, the endpoint will add sandbox prefix
                    UseSandbox = false
                }
            };

Get access token yourself

You can set Options property AutoRequestTokens as false and get Access Token and Security Token by your self. If AutoRequestTokens is true, SellingPartnerApi will get access token and security token when users do not assign or expired.

Refresh Access Token

If you don't have refresh token yet, you may specify the scope.

var config = new Config()
            {
                Region = SpApiRegion.FarEast,
                ...
            };
            
var api = new SellingPartnerApi(config);

var refreshToken = api.RefreshAccessToken(SpApiScope.MIGRATION);

Refresh Access Token with Refresh Token

var config = new Config()
{
    Region = SpApiRegion.FarEast,
    RefreshToken = "<Refresh Token>"
    ...
};
var accessToken = api.RefreshAccessToken();

Refresh User Role Credential

It will return RoleCredentials and save it to the client

var roleCredentials = api.RefreshRoleCredentials();

Call API

This project provide request Class for API so you could check those request Class see which part is required.

Order

Get Order

Endpoint: /orders/v0/orders/@orderId

Mehtod: GET

Request Class: GetOrderRequest

The endpoint with @orderId means that is a path parameter. If you use GetOrderPath object for request, it will replace for you.

var request = new GetOrderRequest();
var path = new GetOrderPath();
path.OrderId = "<Order Id>";

request.Path = path;

var response = nonGrantlessApi.CallGetOrderApi(request);

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT