akoya_token_api v1.0.0
akoya_token_api
AkoyaTokenApi - JavaScript client for akoya_token_api Akoya Token APIs for data recipients. Default servers are set to override for the Akoya sandbox environment. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.00
- Package version: 1.00
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit http://www.akoya.com
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 akoya_token_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 AkoyaTokenApi = require('akoya_token_api');
var defaultClient = AkoyaTokenApi.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'
var api = new AkoyaTokenApi.TokenAPIApi()
var opts = {
'grantType': "grantType_example", // {String}
'redirectUri': "redirectUri_example", // {String}
'code': "code_example" // {String}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.getToken(opts, callback);
Documentation for API Endpoints
All URIs are relative to https://sandbox-idp.ddp.akoya.com
Class | Method | HTTP request | Description |
---|---|---|---|
AkoyaTokenApi.TokenAPIApi | getToken | POST /token | Token |
AkoyaTokenApi.TokenAPIApi | refreshToken | POST /{token} | Refresh token |
Documentation for Models
- AkoyaTokenApi.Error
- AkoyaTokenApi.ObtainTokenRequest
- AkoyaTokenApi.RefreshTokenRequest
- AkoyaTokenApi.TokenResponse
Documentation for Authorization
BasicAuth
- Type: HTTP basic authentication
1 year ago