dkam/paapi
1
0
Fork 0
mirror of https://github.com/dkam/paapi.git synced 2025-12-28 15:14:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add configuration system and documentation. Clean up tests

Browse Source
This commit is contained in:
Dan Milne
2019-09-10 09:25:23 +10:00
parent f1e946d946
commit 250986d1c7
5 changed files with 138 additions and 272 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -20,6 +20,8 @@ Or install it yourself as:
## Usage
### Configuration
The library can be initialised with a Rails initializer such as
```ruby
@@ -35,14 +37,38 @@ Configurable itemes:
* secret_key
* partner_tag
* partner_type
* marketplace
* market
* partner_market
* test_mode
Using the `partner_market` configuration item lets you set a hash of marketplaces and partner_tags.
```ruby
Paapi.configure do |config|
config.access_key = 'your-access-key'
config.secret_key = 'your-secret-key'
config.partner_market = {au: 'au_partner_tag', us: 'us_partner_tag'}
end
client = Paapi::Client.new(market: :au)
client.partner_tag
> 'au_partner_tag'
client.market = :us
client.partner_tag
> 'us_partner_tag'
```
The full list of market keys is `au, br, ca, fr, de, in, it, jp, mx, es, tr, ae, uk, us`
### Using the Paapi
```ruby
require 'paapi'
client = Paapi::Client.new(access_key: ENV['access_key'], secret_key: ENV['secret_key'], marketplace: :au, partner_tag: ENV['partner_tag'])
client = Paapi::Client.new(access_key: ENV['access_key'], secret_key: ENV['secret_key'], market: :au, partner_tag: ENV['partner_tag'])
gi = client.get_items(item_ids: '1857231384')