Giter Club home page Giter Club logo

mws-rb's Introduction

mws_rb

Build Status

This gem is a complete wrapper for Amazon.com's Marketplace Web Service (MWS) API extracted from http://veeqo.com

Installation

Using with a Gemfile:

gem 'mws_rb', require: 'mws'
bundle install

Using in a simple ruby file:

gem install mws_rb
require 'mws'

Initialization

MWS API
    mws_api = MWS.new(
      host: "mws-eu.amazonservices.com",
      aws_access_key_id: "Your access key id",
      aws_secret_access_key: "Your secret access key",
      seller_id: "Your seller/merchant id"
    )
MWS AUTH
    mws_auth = MWS.auth(
      aws_access_key_id: "Your access key id",
      aws_secret_access_key: "Your secret access key",
      app_instance_id: "Your application instance id",
      host: "sellercentral.amazon.co.uk", # or another marketplace
      uri: "/gp/mws/registration/register.html",
      return_path: "/auth/oauth_callback?sessionID=your_session_id"
    )

Using

MWS API

To access the apis you can use:

     mws_api._api_name_._action_to_calll(params={})

Let's say we want to retrieve a list of orders using MWS orders api:

    mws_api.orders.list_orders(
      "MarketplaceId.Id.1" => "marketplace id",
      created_after: Time.new(2013, 1, 1)
    )

Here is a list of all available APIS:

  • mws_api.feeds
  • mws_api.orders
  • mws_api.reports
  • mws_api.products
  • mws_api.sellers
  • mws_api.subscriptions
  • mws_api.recommendations
  • mws_api.fulfillment_inventory
  • mws_api.fulfillment_inbound_shipment
  • mws_api.fulfillment_outbound_shipment
  • mws_api.merchant_fulfillment
MWS AUTH

To get authorization url for your marketplace:

     mws_auth.authorization_url

And after successful authentication on Amazon side it will redirect you to your callback url:

    POST www.your-domain.com/auth/oauth_callback

with params:

    params = {
      'sessionID': 'your_session_id', # custom param
      'Merchant': 'Merchant ID',
      'Marketplace': 'Merchant Marketplace',
      'MWSAuthToken': 'MWS authorization token',
      'SignatureMethod': 'HmacSHA256',
      'SignatureVersion': '2',
      'Signature': 'Signature generated from your side and have sent to Amazon',
      'AWSAccessKeyId': 'Amazon access key for the marketplace',
      'SignedString': "POST\nhttps://www.vendor.com/mwsApp1\n/orders/listRecentOrders.jsp?sessionId=123\nAWSAccessKeyId=AKIAFJPPO5KLY6G4XO7Q&MWSAuthToken=mzn.mws.1234&Marketplace=ATVPDKIKX0DER&Merchant=A047950713KM6AGKQCBRD&SignatureMethod=HmacSHA256&SignatureVersion=2"
    }

NOTE: Before saving the credentials to your DB check the validity of the received signature:

mws_auth.valid_signature?(signature: params[:Signature], signed_string: params[:SignedString])

API docs/actions/params

You can check on the MWS documentation section all actions and params needed:

LICENSE

Copyright (c) Jhimy Fernandes Villar

mws-rb's People

Contributors

stjhimy avatar main24 avatar yevgenko avatar danielvartanov avatar ulandj avatar calvinhughes avatar dlachasse avatar matt423 avatar vbyno avatar 721p avatar rdj avatar

Stargazers

Nikhil Goyal avatar Tatsuro Moriyama avatar Ketzelle avatar Hemal avatar Diego Selzlein avatar Mark Kreyman avatar Albert Farhi avatar Jordan Sitkin avatar  avatar Rob Graham avatar  avatar

Watchers

 avatar  avatar Vlad Bokov avatar Oleksii Kuznietsov avatar Adis Osmonov avatar James Cloos avatar  avatar  avatar Rustam Sharshenov avatar Artur Sitarski avatar  avatar Luke Farmer avatar Andrew S. avatar  avatar  avatar  avatar  avatar

mws-rb's Issues

Invalid request on Products API

I'm receiving an error on the Products API indicating invalid request on every operation outside of the GetServiceStatus, to which I receive "GREEN". The only other API I've tried accessing is Recommendations which also appears to work properly. Following is the error message I'm receiving.
"Error"=>{"Type"=>"Sender", "Code"=>"InvalidAddress", "Message"=>"Operation GetMyPriceForSku is not available for section Products/2011-10-01"}

Configurable MWS

Moving aws key and aws secret into configurable options of MWS will very useful.
It will allow to use different configuration for each environment and easily manage this options.
For example, expecting usage is something like this:

# config/environments/production.rb

MWS.configure do |config|
  config.aws_key = 'SOMEAWSKEY'
  config.aws_secret = 'SOMEAWSSECRET'
end

MarketplaceId parameter

Some of the API calls require the MarketplaceId parameter but the connection doesn't take this info. Any chance this will be added in soon?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.