traccar-api-client v4.5.0

traccar-api-client

Traccar - JavaScript client for traccar No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 4.5
• Package version: 4.5.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 traccar-api-client --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 traccar from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('traccar') 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 Traccar = require('traccar-api-client');

var defaultClient = Traccar.ApiClient.instance;
// Configure HTTP API Server
defaultClient.basePath = 'https://YOUR-TRACCAR-SERVER/api';

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new Traccar.DefaultApi()

var opts = { 
  'all': true, // {Boolean} Can only be used by admins or managers to fetch all entities
  'userId': 56, // {Number} Standard users can use this only with their own _userId_
  'deviceId': 56, // {Number} Standard users can use this only with _deviceId_s, they have access to
  'groupId': 56, // {Number} Standard users can use this only with _groupId_s, they have access to
  'refresh': true // {Boolean} 
};

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

Documentation for API Endpoints

All URIs are relative to http://demo.traccar.org/api

Documentation for Models

• Traccar.Attribute
• Traccar.Calendar
• Traccar.Command
• Traccar.CommandType
• Traccar.Device
• Traccar.DeviceAccumulators
• Traccar.Driver
• Traccar.Event
• Traccar.Geofence
• Traccar.Group
• Traccar.Maintenance
• Traccar.Notification
• Traccar.NotificationType
• Traccar.Permission
• Traccar.Position
• Traccar.ReportStops
• Traccar.ReportSummary
• Traccar.ReportTrips
• Traccar.Server
• Traccar.Statistics
• Traccar.User

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication