Skip to content

Commit d6d165e

Browse files
committed
chore: minor readme updates
1 parent 73c0c37 commit d6d165e

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[![npm](https://img.shields.io/npm/dt/ebay-api.svg?style=flat-square)](https://www.npmjs.com/package/ebay-api)
1010

1111
This eBay API implements both Traditional \(xml\) and the RESTful eBay API.
12-
It supports `client credentials grant` and `authorization code grant` \(Auth'N'Auth, OAuth2 and IAF\).
12+
It supports `client credentials grant` and `authorization code grant` \(Auth'N'Auth, OAuth2 and IAF\). Digital Signature is supported too.
1313

1414
* [API Browser Examples](https://hendt.github.io/ebay-api/)
1515
* [API Documentation](https://hendt.gitbook.io/ebay-api/)
@@ -88,9 +88,9 @@ const eBay = new eBayApi({
8888

8989
siteId: eBayApi.SiteId.EBAY_US, // required for traditional APIs, see https://developer.ebay.com/DevZone/merchandising/docs/Concepts/SiteIDToGlobalID.html
9090

91-
marketplaceId: eBayApi.MarketplaceId.EBAY_US, // defautl. required for RESTful APIs
92-
acceptLanguage: eBayApi.Locale.en_US, // defautl
93-
contentLanguage: eBayApi.ContentLanguage.en_US, // defautl.
91+
marketplaceId: eBayApi.MarketplaceId.EBAY_US, // default. required for RESTful APIs
92+
acceptLanguage: eBayApi.Locale.en_US, // default
93+
contentLanguage: eBayApi.ContentLanguage.en_US, // default.
9494

9595
// optional parameters, should be omitted if not used
9696
devId: '-- devId --', // required for traditional Trading API
@@ -254,6 +254,8 @@ This is how it would look like if you use `express`:
254254
```javascript
255255
import eBayApi from 'ebay-api';
256256

257+
258+
// This is your RUName endpoint like https://your-ebay.app/success
257259
app.get('/success', async function (req, res) {
258260
// 3. Get the parameter code that is placed as query parameter in redirected page
259261
const code = req.query.code; // this is provided from eBay
@@ -375,7 +377,7 @@ In any case eBay adds a new subdomain, it's also possible to configure whatever
375377
eBay.buy.browse.api({subdomain: 'apiy'}).getItem() // now it will use https://apiy.ebay.com
376378
```
377379

378-
### Change RESTful API call config
380+
### Return raw RESTful API response
379381

380382
```javascript
381383
eBay.buy.browse.api({
@@ -403,8 +405,8 @@ eBay.OAuth2.on('refreshClientToken', (token) => {
403405
});
404406
```
405407

406-
To manuel refresh the auth token use `eBay.OAuth2.refreshAuthToken()` and for the client
407-
token `eBay.OAuth2.refreshClientToken()`.
408+
To manual refresh the auth token use `eBay.OAuth2.refreshAuthToken()` and for the client
409+
token use `eBay.OAuth2.refreshClientToken()`.
408410
Keep in mind that you need the 'refresh_token' value set.
409411

410412
```javascript

0 commit comments

Comments
 (0)