rk_sdk
v1.1.0
Published
An SDK to retrieve passwords for required accounts, offering seamless integration with RK services.
Downloads
6
Readme
password_retrieval_api
PasswordRetrievalApi - JavaScript client for password_retrieval_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.10.0
- Build package: org.openapitools.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 password_retrieval_api --saveFinally, you need to build the module:
npm run buildLocal 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 installNext, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
npm linkTo use the link you just defined in your project, switch to the directory you want to use your password_retrieval_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>Finally, you need to build the module:
npm run buildgit
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 --saveFor 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.jsThen 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 PasswordRetrievalApi = require('password_retrieval_api');
var api = new PasswordRetrievalApi.DefaultApi()
var opts = {
'accountId': null, // {Number}
'accountName': "accountName_example", // {String}
'accountTitle': "accountTitle_example", // {String}
'accountType': "accountType_example" // {String}
};
api.getPassword(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to http://https:/api
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- PasswordRetrievalApi.DefaultApi | getPassword | GET /get_password | Retrieves password information
Documentation for Models
Documentation for Authorization
Endpoints do not require authorization.
