aci_api_js_client v2.0.0

aci_services_api

AciServicesApi - JavaScript client for aci_services_api API for methods pertaining to all ACI services This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0.0
• Package version: 2.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 aci_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 aci_services_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('aci_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 AciServicesApi = require('aci_services_api');

var defaultClient = AciServicesApi.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 AciServicesApi.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vehicleHistoryFullOptions(callback);

Documentation for API Endpoints

All URIs are relative to https://aci.prod.autotec.com/api/

Documentation for Models

• AciServicesApi.Empty
• AciServicesApi.HistoryRecord
• AciServicesApi.HistoryRequest
• AciServicesApi.HistoryResponse
• AciServicesApi.RecallRecord
• AciServicesApi.RiskCalculationPlusResponse
• AciServicesApi.RiskCalculationRequest
• AciServicesApi.RiskCalculationResponse
• AciServicesApi.UnprocessedHistoryRequests
• AciServicesApi.UnprocessedRiskCalculationRequests
• AciServicesApi.Vehicle
• AciServicesApi.VehicleHistory
• AciServicesApi.VehicleInformation
• AciServicesApi.VehicleOwnershipActivity
• AciServicesApi.VehicleRecall
• AciServicesApi.VehicleRequestAttribute
• AciServicesApi.VehicleRiskRequestAttribute
• AciServicesApi.VehicleRiskResult
• AciServicesApi.VehicleScoring

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