marketplace_cms_api
v1.0.0
Published
API_to_be_used_by_marketplace_to_get_CMS_data
Downloads
2
Readme
marketplace_cms_api
MarketplaceCmsApi - JavaScript client for marketplace_cms_api API to be used by marketplace to get CMS data This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.javascript.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 marketplace_cms_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --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):
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 MarketplaceCmsApi = require('marketplace_cms_api');
var api = new MarketplaceCmsApi.BannersApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAllBanners(callback);
Documentation for API Endpoints
All URIs are relative to https://virtserver.swaggerhub.com/mmounirf/cms/1.0.0
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MarketplaceCmsApi.BannersApi | getAllBanners | GET /banners | Get all banners MarketplaceCmsApi.BannersApi | getDefaultBanner | GET /banners/default | Get default banner
Documentation for Models
- MarketplaceCmsApi.Banner
- MarketplaceCmsApi.Banner375
- MarketplaceCmsApi.Banner375Banner1
- MarketplaceCmsApi.Banner375Banner2
- MarketplaceCmsApi.Banner375Banner3
- MarketplaceCmsApi.Banners
Documentation for Authorization
All endpoints do not require authorization.