bl_amazon_api v0.0.7
bl_amazon_api
BlAmazonApi - JavaScript client for bl_amazon_api This is an API documentation for the Bluehack Amazon Service. This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.7
- Package version: 0.0.7
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install bl_amazon_api --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your bl_amazon_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('bl_amazon_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/bl_amazon_api then install it via:
npm install YOUR_USERNAME/bl_amazon_api --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var BlAmazonApi = require('bl_amazon_api');
var api = new BlAmazonApi.AdvertisingApi()
var nodeId = "nodeId_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAdvertisingBrowseNode(nodeId, callback);
Documentation for API Endpoints
All URIs are relative to http://104.198.83.158:80
Class | Method | HTTP request | Description |
---|---|---|---|
BlAmazonApi.AdvertisingApi | getAdvertisingBrowseNode | GET /advertising/browseNodes/{nodeId} | Get browse node hierarchy from Amazon |
BlAmazonApi.AdvertisingApi | getAdvertisingBrowseNodeTopSellers | GET /advertising/browseNodes/{nodeId}/topSellers | Get 10 top sellers within a specified browse node from Amazon |
BlAmazonApi.AdvertisingApi | getAdvertisingStatus | GET /advertising/status | Get Amazon Product Advertising API status |
BlAmazonApi.MwsApi | getMwsFeedsSubmissions | GET /mws/feeds/submissions | Get a list of feed submissions submitted |
BlAmazonApi.MwsApi | getMwsFeedsSubmissionsResult | GET /mws/feeds/submissions/{feedSubmissionId}/result | Get the feed processing report |
BlAmazonApi.MwsApi | getMwsStatus | GET /mws/status | Get Amazon MWS API status |
BlAmazonApi.MwsApi | postSubmitFeed | POST /mws/feeds/submit | Post feed with a flat file |
BlAmazonApi.ProductApi | getProductsBrowseNodeAttributes | GET /products/browseNodes/{nodeId}/attributes | Get attributes within a specified browse node for the title generating |
BlAmazonApi.ProductApi | getProductsBrowseNodeValidValue | GET /products/browseNodes/{nodeId}/validValue | Get the browse node's valid value for submiting a flat file |
BlAmazonApi.ProductApi | getProductsStatus | GET /products/status | Get Product API status |
BlAmazonApi.ToolApi | getDictionaryBrowseNodesAll | GET /tool/dictionary/browseNodes/{nodeId}/all | Get all dictionary hierarchy within a specified browse node |
BlAmazonApi.ToolApi | getDictionaryProductsAttrs | GET /tool/dictionary/products/{nodeId}/attrs/{attrId} | Get an attribute within a specified browse node's |
BlAmazonApi.ToolApi | getDictionaryProductsAttrsSubAttrs | GET /tool/dictionary/products/{nodeId}/attrs/{attrId}/subAttrs/{subAttrId} | Get a sub attribute within a specified browse node's attribute |
BlAmazonApi.ToolApi | getDictionaryProductsAttrsSubAttrsWords | GET /tool/dictionary/products/{nodeId}/attrs/{attrId}/subAttrs/{subAttrId}/words | Check the dic_word contains within a specified browse node's attribute's sub attribute |
BlAmazonApi.ToolApi | getDictionarySubAttrsWords | GET /tool/dictionary/subAttrs/words | Get dictionary words with subAttrId list |
BlAmazonApi.ToolApi | getDictionaryWords | GET /tool/dictionary/words | DEPRECATED Get dictionary words for filtering within specified browse nodes |
BlAmazonApi.ToolApi | getDictionaryWordsFiltered | GET /tool/dictionary/words/{nodeId}/filtered | Get filtered words within a specified browse node with filtering words |
BlAmazonApi.ToolApi | getToolTitles | GET /tool/titles/{nodeId} | Get 100 amazon best selling item titles within a specified browse node |
BlAmazonApi.ToolApi | postDictionaryProductsAttrs | POST /tool/dictionary/products/{nodeId}/attrs/{attrId} | Add attribute within a specified browse node's |
BlAmazonApi.ToolApi | postDictionaryProductsAttrsSubAttrs | POST /tool/dictionary/products/{nodeId}/attrs/{attrId}/subAttrs/{subAttrId} | Add sub attribute within a specified browse node's attribute |
BlAmazonApi.ToolApi | postDictionaryProductsAttrsSubAttrsWords | POST /tool/dictionary/products/{nodeId}/attrs/{attrId}/subAttrs/{subAttrId}/words | Add a dic_word within a specified browse node's attribute's sub attribute |
BlAmazonApi.ToolApi | postDictionarySubAttrsWordsCountReset | POST /tool/dictionary/subAttrs/words/count/reset | Reset title_dic counts |
BlAmazonApi.ToolApi | postDictionaryWords | POST /tool/dictionary/words | DEPRECATED Add filtering word to dictionary |
Documentation for Models
- BlAmazonApi.Attr
- BlAmazonApi.BrowseNode
- BlAmazonApi.FeedSubmissionInfo
- BlAmazonApi.GetAdvertisingBrowseNodesResponse
- BlAmazonApi.GetAdvertisingBrowseNodesResponseData
- BlAmazonApi.GetAdvertisingBrowseNodesTopSellersResponse
- BlAmazonApi.GetAdvertisingBrowseNodesTopSellersResponseData
- BlAmazonApi.GetAdvertisingStatusResponse
- BlAmazonApi.GetDictionaryBrowseNodesAllResponse
- BlAmazonApi.GetDictionaryBrowseNodesAllResponseData
- BlAmazonApi.GetDictionaryBrowseNodesAllResponseSubAttrs
- BlAmazonApi.GetDictionaryProductsAttrsResponse
- BlAmazonApi.GetDictionaryProductsAttrsSubAttrsResponse
- BlAmazonApi.GetDictionaryProductsAttrsSubAttrsWordsResponse
- BlAmazonApi.GetDictionarySubAttrsWordsResponse
- BlAmazonApi.GetDictionaryWordsFilteredResponse
- BlAmazonApi.GetDictionaryWordsFilteredResponseData
- BlAmazonApi.GetDictionaryWordsFilteredResponseDataWords
- BlAmazonApi.GetDictionaryWordsResponse
- BlAmazonApi.GetDictionaryWordsResponseData
- BlAmazonApi.GetMwsFeedsSubmissionsResponse
- BlAmazonApi.GetMwsFeedsSubmissionsResponseData
- BlAmazonApi.GetMwsFeedsSubmissionsResultResponse
- BlAmazonApi.GetMwsFeedsSubmissionsResultResponseData
- BlAmazonApi.GetMwsStatusResponse
- BlAmazonApi.GetProductsBrowseNodeAttributesResponse
- BlAmazonApi.GetProductsBrowseNodeAttributesResponseData
- BlAmazonApi.GetProductsBrowseNodeValidValueResponse
- BlAmazonApi.GetProductsBrowseNodeValidValueResponseData
- BlAmazonApi.GetProductsStatusResponse
- BlAmazonApi.GetToolTitlesResponse
- BlAmazonApi.GetToolTitlesResponseData
- BlAmazonApi.PostDictionaryProductsAttrsResponse
- BlAmazonApi.PostDictionaryProductsAttrsSubAttrsResponse
- BlAmazonApi.PostDictionaryProductsAttrsSubAttrsWordsResponse
- BlAmazonApi.PostDictionarySubAttrsWordsCountResetResponse
- BlAmazonApi.PostDictionaryWordsResponse
- BlAmazonApi.PostSubmitFeedResponse
- BlAmazonApi.PostSubmitFeedResponseData
- BlAmazonApi.SubAttr
- BlAmazonApi.TitleDic
- BlAmazonApi.TopItem
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header