From bbbf9a49f2fe0c789889b1d28fd0b2b09219e97e Mon Sep 17 00:00:00 2001 From: Andrey Novikov Date: Mon, 13 Nov 2017 19:08:33 +0300 Subject: [PATCH] Add a note about difference between OAuth and Auth'n'auth --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e7bf8ec..7f6d979 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,43 @@ OmniAuth Strategy for eBay Apps (for using with eBay REST APIs) Sponsored by Evil Martians +## Preface + +> Why do I need it? There are a couple of other gems with OmniAuth strategies for eBay? + +eBay has two different authorization methods: Auth'n'auth and OAuth. Technically, they are both uses OAuth2 protocol (just to embrace a little confusion). + +This gem implements authorization with OAuth method while currently available gems (like [ebay_request](https://github.com/gzigzigzeo/ebay_request) or [omniauth-ebay](https://github.com/TheGiftsProject/omniauth-ebay)) implements Auth'n'auth. + +__What is the difference? Access tokens!__ + +With Auth'n'auth you will get a single token which you can use to access old eBay XML APIs (Trading API, etc.) + +With OAuth, you will get a pair of access and refresh tokens which can be used to access new eBay REST APIs (Buy API, Sell API, etc.) + +However, you can use new OAuth tokens to access old APIs by providing an access token in (not yet) documented HTTP header `X-EBAY-API-IAF-TOKEN` (like this gem uses it to obtain information about an authenticated user from Trading API). + +If you plan to use only old APIs, you can look at [ebay_request](https://github.com/gzigzigzeo/ebay_request) gem. + +If you plan to use new APIs, you are welcome to use this gem either standalone or together with [ebay_api](https://github.com/nepalez/ebay_api) client get for REST APIs. + +Now you can read the eBay docs about [REST APIs](https://developer.ebay.com/api-docs/static/ebay-rest-landing.html) and [OAuth](https://developer.ebay.com/api-docs/static/oauth-quick-ref-user-tokens.html) and then proceed to… + ## Installation Add to your Gemfile: -`gem 'omniauth-ebay-oauth'` +```ruby +gem 'omniauth-ebay-oauth' +``` + +Then execute: + +```sh +bundle install +``` -Then `bundle install`. ## Usage @@ -36,6 +65,7 @@ Additional options: Additional usage information could be found on [OmniAuth README page](). + ## Minimal working Sinatra application: ```ruby