This is an unofficial client library for the ShareaSale affiliate reporting API. It does not include the publisher API or any other APIs at the moment. Please see below for the supported endpoints as well as a required and optional parameters on each endpoint.
Add this line to your application's Gemfile:
gem 'teilashare'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install teilashare
Instantiate a client via:
credentials = {
token: ENV['TOKEN'],
api_secret: ENV['API_SECRET'],
affiliate_id: ENV['affiliate_id']
}
client = Teilashare.new(credentials)
You can then request reports on this client via:
result = client.today_stats(format: 'xml')
Please refer to the Teilashare documentation for required and optional parameters for your desired report. The default format is CSV, but you can request XML format or pipe formatted data (PSV?) via the format option.
required params:
optional
client.activity_details(
start_date: '07-31-2020',
end_date: '08-31-2020',
merchant_id: 234234234
)
required params:
optional params
client.activity_summary(sort_col: 'salestotal', sort_dir: 'asc')
required params:
optional params
csv = client.merchant_timespan(date_start: '12/31/2020')
required params
optional params
client.today_stats(
distinct_link: 1,
sort_col: 'commissions',
sort_dir: 'asc'
)
required params
optional params
client.monthly_summary(
date_month: '12/01/2020',
sort_col: 'commissions',
sort_dir: 'asc'
)
required params
optional params
client.void_trail(
date_start: '12/01/2020'
)
required params
optional params
conditionally required
client.traffic(
date_start: '12/01/2020'
)
required params
optional params
client.api_token_count
required params
optional params
client.products(
keyword: 'wool hats'
)
required params
optional params
client.invalid_links(
merchantIdList: 12342,1234234,234234
)
required params
optional params
client.order_inquiry(
merchant_id: 1234,
order_date: '12/31/2020',
order_number: abcdef234
)
required params
optional params
client.merchant_datafeed
required params
optional params
client.coupon_deal
required params
optional params
client.merchant_status
required params
optional params
conditional params
client.merchant_creative
required params
optional params
client.merchant_gift_cards
required params
optional params
client.edit_trail
required params
optional params
client.payment_summary
required params
optional params
client.merchant_search(keyword: 'wool')
required params
optional params
client.merchant_search_by_product(keyword: 'shoes')
required params
optional params
client.ledger_report
required params
optional params
client.balance_inquiry
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
If you want to record API requests, you'll need to export environment variables in the format:
export TOKEN=abc
export AFFILIATE_ID=123456789
export API_SECRET=def
export API_VERSION=2.3
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/tommycarney/partagerasale.
The gem is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that teilashare demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.