@metashop/node-sdk
v1.1.1
Published
Swagger_Doc_api_for_Metashop
Downloads
7
Readme
@metashop/node-sdk
MetashopApi - JavaScript client for @metashop/node-sdk Swagger Doc api for Metashop This SDK is automatically generated by the Swagger Codegen project:
- API version: v1
- Package version: v1
- 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 @metashop/node-sdk --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 @metashop/node-sdk from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('@metashop/node-sdk')
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/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, 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 MetashopApi = require('@metashop/node-sdk');
var defaultClient = MetashopApi.ApiClient.instance;
// Configure API key authorization: access-token
var access-token = defaultClient.authentications['access-token'];
access-token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access-token.apiKeyPrefix['access-token'] = "Token"
// Configure API key authorization: client
var client = defaultClient.authentications['client'];
client.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//client.apiKeyPrefix['client'] = "Token"
// Configure API key authorization: uid
var uid = defaultClient.authentications['uid'];
uid.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uid.apiKeyPrefix['uid'] = "Token"
var api = new MetashopApi.AuthenticationApi()
api.authDelete().then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to https://localhost/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MetashopApi.AuthenticationApi | authDelete | DELETE /auth/ | Account Delete MetashopApi.AuthenticationApi | authPasswordGet | GET /auth/password | Confirm Reset Password Token MetashopApi.AuthenticationApi | authPasswordPost | POST /auth/password | Get Link Reset Password From Email MetashopApi.AuthenticationApi | authPasswordPut | PUT /auth/password | Change Password MetashopApi.AuthenticationApi | authPost | POST /auth/ | Create User MetashopApi.AuthenticationApi | authPut | PUT /auth/ | Upadate User MetashopApi.AuthenticationApi | authSignInPost | POST /auth/sign_in | Login User MetashopApi.AuthenticationApi | authSignOutDelete | DELETE /auth/sign_out | Logout User MetashopApi.AuthenticationApi | authValidateTokenGet | GET /auth/validate_token | Validate Token User MetashopApi.PasswordApi | authPasswordGet | GET /auth/password | Confirm Reset Password Token MetashopApi.PasswordApi | authPasswordPost | POST /auth/password | Get Link Reset Password From Email MetashopApi.PasswordApi | authPasswordPut | PUT /auth/password | Change Password MetashopApi.ProductApi | productsGet | GET /products | Get List of Products MetashopApi.StoreApi | productsGet | GET /products | Get List of Products MetashopApi.StoreApi | storesInfoGet | GET /stores/info | Get Store info
Documentation for Models
Documentation for Authorization
access-token
- Type: API key
- API key parameter name: access-token
- Location: HTTP header
client
- Type: API key
- API key parameter name: client
- Location: HTTP header
uid
- Type: API key
- API key parameter name: uid
- Location: HTTP header