qrlio-scripting

Scripting API for the qrlio.com passive tracking service.

The only direct dependency is node-fetch, but should you use this from a browser you can remove the dependency.

Prerequisites

1. You need to have an account at qrlio.com. You can register the account for free and that includes a handful of test credits which you can use for evaluation.
2. You need basic knowledge of node.js in order to use this API. There is plenty of documentation online.
3. You need yarn or npm and some knowledge of how that works.

Installation by NPM/Yarn

1. Add this package to your project by running either yarn add qrlio-script OR npm install qrlio-script
2. Import this package in your own file, for example like this

   const qrlio = require('qrlio-script/qrlio-api');
   const f = async () => {
      const login = await qrlio.qrlioLogin("myusername", "mypassword");
      console.log(login);
      console.log(qrlio.qrlioGetClient());
   }
   f();

Installation by Source

1. Clone this repository to your machine.

2. At the top level directory, execute: yarn install

3. Make your own script or try the example script:

   USER={your-username} PASS={your-password} node example.js

API (v1) versus API v2

The v2 API differs by that it does not cache a single user session but instead has a separate object for each user. This is in order to support context-free servers which serves requests by multiple users. In this version the Login function returns an object which is then used as the first parameter in each subsequent call. You can have multiple sessions at once.

   const qrlio = require('qrlio-script/qrlio-api-v2');
   const f = async () => {
      const session = await qrlio.qrlioLogin("myusername", "mypassword");
      console.log(qrlio.qrlioGetClient(session));
   }
   f();