Skip to content

This is a node api with some resources from the amazon selling partner api

Notifications You must be signed in to change notification settings

CesarObedFL/aws_node_selling_partner_api

Repository files navigation

aws node selling partner api

This api let you connect to the Amazon SP API using their SDK...

First of all following the official-documentation and spapi-docs!!!...

Consult the spapi-reference

Features

  • It is in charge of connecting to the amazon api, seller partner api
  • Through the SDK manages the client and the corresponding credentials for the connection to amazon
  • Use express as http client
  • You can use in production PM2 as process daemon to linux servers
  • You can dockerizing it with the docker file using the official PM2-image in the latest-alpine version

Dependencies

Requirements

  • npm ^8.3.1
  • node ^16.13.2
  • PM2
  • Docker ^20.10.17 optional

Installation

npm install 

Dockerizing

docker build -t your-app-name .

Running the app

development mode: npm run serve

production mode: you have to use PM2 or a similar daemon package to run on background the app and use it

pm2 start index.js

with docker:

docker run -p 3000:3000 your-app-name

docker terminal:

docker run -it your-app-name sh

.env file explanation

Following the official-documentation!!!...

You can get the following data on the Amazon seller-central-portal!... you need to be registered as a developer there, that process could take about two weeks...

data description
APP_ID Represents your application on the Amazon platform, example: amzn1.sp.solution....
APP_REGION Indicates the geographic region in which your application is authorized
APP_CLIENT_ID Indicates the geographic region in which your application is authorized This is a unique identifier that represents the application in the context of Login with Amazon (LWA). Also obtained when you register your application in the Amazon Developer Console. example: amzn1.application-oa2-client....
APP_CLIENT_SECRET The client secret is a secret key that corresponds to the APP_CLIENT_ID
APP_CLIENT_ACCESS_TOKEN It is a token that represents your application's authorization to access the Seller Partner API
APP_CLIENT_REFRESH_TOKEN It is a token that is used to renew the client access token if it expires

This data is essential for the authentication and authorization of your application in the Amazon Seller Partner API through Login with Amazon (LWA). They establish the identity of your application and ensure that only authorized applications can access the API. Additionally, the access token and refresh token allow your application to securely access API resources and keep authentication active

The following is data extracted from the IAM user created in AWS:

data description
AWS_ACCESS_KEY_ID This is a unique identifier that represents the AWS access key of the user seeking to access the API. Amazon provides this ID when you set up a user in AWS IAM (Identity and Access Management). The AWS_ACCESS_KEY_ID is used to authenticate the request and associate it with a specific user in your AWS account
AWS_SECRET_ACCESS_KEY The secret access key is a key that corresponds to the AWS_ACCESS_KEY_ID. It must be kept secret and is essential for authenticating and authorizing requests to the API. Similar to the access key, it is obtained when setting up a user in AWS IAM
AWS_SELLING_PARTNER_ROLE This is the AWS role that you define for your application or system to access the Seller Partner API. The AWS_SELLING_PARTNER_ROLE defines the permissions and access policies that apply to requests made to the API. You can configure this role in AWS IAM and assign it to your application or system to ensure that it has the appropriate permissions to access the API

This data allows your application or system to securely authenticate and authorize itself to the Amazon Seller Partner API. The AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used to authenticate requests, while the AWS_SELLING_PARTNER_ROLE determines what actions and resources can be accessed by the application or system in the API. This helps ensure that only authorized applications and systems have access to API resources

The following is data extracted from the AssumeRole of AWS:

data description
ROLE_ID This is a unique identifier that represents the temporary role you want to assume in the Amazon Seller Partner API. Amazon provides you with this ID when you set up a temporary role through AWS Identity and Access Management (IAM) in your Amazon Web Services (AWS) account
ROLE_SECRET The temporary role secret is a secret key that corresponds to the ROLE_ID
ROLE_SECURITY_TOKEN This security token is a generated temporary value that is used to authenticate and authorize requests to the API on behalf of the temporary role. It is an additional security measure to verify the authenticity of the request. This token is also obtained when assuming the temporary role and should be included in your API requests

This data is essential to establish a secure and authorized connection to the Amazon Seller Partner API when assuming a temporary role. The process involves authentication and authorization using the ROLE_ID, ROLE_SECRET, and ROLE_SECURITY_TOKEN, allowing your application or system to interact with the API on behalf of the configured temporary role

About

This is a node api with some resources from the amazon selling partner api

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published