vxc_services_api
v3.0.0
Published
API_for_methods_pertaining_to_all_VXC_services
Downloads
9
Readme
vxc_services_api
VxcServicesApi - JavaScript client for vxc_services_api API for methods pertaining to all VXC services This SDK is automatically generated by the Swagger Codegen project:
- API version: 3.0.0
- Package version: 3.0.0
- 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 vxc_services_api --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 vxc_services_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('vxc_services_api')
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 VxcServicesApi = require('vxc_services_api');
var defaultClient = VxcServicesApi.ApiClient.instance;
// Configure API key authorization: CustomerAuthorizer
var CustomerAuthorizer = defaultClient.authentications['CustomerAuthorizer'];
CustomerAuthorizer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CustomerAuthorizer.apiKeyPrefix['Unused'] = "Token"
var api = new VxcServicesApi.BrickFTPApi()
var opts = {
'xApiKey': "xApiKey_example", // {String} the AutoTec assigned authentication credential for the calling customer
'xAutotecId': "xAutotecId_example" // {String} the AutoTec assigned identification id for the calling customer
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.brickftp(opts, callback);
Documentation for API Endpoints
All URIs are relative to https://vxc.prod.autotec.com/api/
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- VxcServicesApi.BrickFTPApi | brickftp | GET /webhook/brickftp/vxc | Webhook for VXC BrickFTP implementations VxcServicesApi.BrickFTPApi | brickftp_0 | GET /webhook/brickftp/vxc/compressed | Webhook for VXC compressed file transfer VxcServicesApi.BrickFTPApi | brickftp_1 | GET /webhook/brickftp/vxc/encrypted | Webhook for VXC encrypted file transfer VxcServicesApi.DefaultApi | vehicleFinancialPortfolioAddOptions | OPTIONS /vehicle/financial/portfolio/add | VxcServicesApi.DefaultApi | vehicleFinancialPortfolioAlertsOptions | OPTIONS /vehicle/financial/portfolio/alerts | VxcServicesApi.DefaultApi | vehicleFinancialPortfolioRemoveOptions | OPTIONS /vehicle/financial/portfolio/remove | VxcServicesApi.DefaultApi | webhookBrickftpVxcCompressedOptions | OPTIONS /webhook/brickftp/vxc/compressed | VxcServicesApi.DefaultApi | webhookBrickftpVxcEncryptedOptions | OPTIONS /webhook/brickftp/vxc/encrypted | VxcServicesApi.DefaultApi | webhookBrickftpVxcOptions | OPTIONS /webhook/brickftp/vxc | VxcServicesApi.VehicleFinanceApi | addFinancialPortfolio | POST /vehicle/financial/portfolio/add | Add financial portfolios VxcServicesApi.VehicleFinanceApi | financialPortfolioAlerts | GET /vehicle/financial/portfolio/alerts | Retrieve financial portfolio alerts VxcServicesApi.VehicleFinanceApi | removeFinancialPortfolio | POST /vehicle/financial/portfolio/remove | Remove financial portfolios
Documentation for Models
- VxcServicesApi.Empty
- VxcServicesApi.FinancialPortfolioAddRequest
- VxcServicesApi.FinancialPortfolioRequest
- VxcServicesApi.FinancialPortfolioResponse
- VxcServicesApi.FinancialPortfolioResponseErrors
- VxcServicesApi.Request
- VxcServicesApi.Request1
- VxcServicesApi.VehicleFinanceDealer
- VxcServicesApi.VehicleFinanceDetails
- VxcServicesApi.VehicleFinanceLocation
- VxcServicesApi.VehicleFinanceOdometer
- VxcServicesApi.VehicleFinancePortfolio
- VxcServicesApi.VehicleFinanceRecord
- VxcServicesApi.VehiclefinancialportfolioremoveRecords
Documentation for Authorization
CustomerAuthorizer
- Type: API key
- API key parameter name: Unused
- Location: HTTP header
api_key
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header