CreditCockpit - JavaScript client for credit_cockpit CreditCockpit API This SDK is automatically generated by the OpenAPI Generator project:
- API version: v1
- Package version: v1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For Node.js
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install credit_cockpit --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your credit_cockpit from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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
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.
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
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var CreditCockpit = require('credit_cockpit');
var defaultClient = CreditCockpit.ApiClient.instance;
// Configure API key authorization: apiKeyHeader
var apiKeyHeader = defaultClient.authentications['apiKeyHeader'];
apiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"
// Configure API key authorization: apiKeyQuery
var apiKeyQuery = defaultClient.authentications['apiKeyQuery'];
apiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyQuery.apiKeyPrefix['subscription-key'] = "Token"
var api = new CreditCockpit.DefaultApi()
var businessPartnernumber = "businessPartnernumber_example"; // {String} Business Partner Number in SAP
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getBlockedorder(businessPartnernumber, callback);
All URIs are relative to https://api.nonprd.lyb.com/credit/v1
Class | Method | HTTP request | Description |
---|---|---|---|
CreditCockpit.DefaultApi | getBlockedorder | GET /blockedorder | Get the blocked order |
CreditCockpit.DefaultApi | getBusinesspartner | GET /businesspartner | Get the business partner information |
CreditCockpit.DefaultApi | getCredituser | GET /credituser | Get Credit User |
- CreditCockpit.BlockedOrder
- CreditCockpit.BusinessPartner
- CreditCockpit.CreditUser
- CreditCockpit.Error
- CreditCockpit.KeyValuePair
- Type: API key
- API key parameter name: Ocp-Apim-Subscription-Key
- Location: HTTP header
- Type: API key
- API key parameter name: subscription-key
- Location: URL query string