@wwu-restek/srapi
This module (class) simplifies the process of implementing calls to StarRez's REST API by providing a few wrapper functions.
Last updated a year ago by wwubrent .
GPL-3.0-or-later · Original npm · Tarball · package.json
$ cnpm install @wwu-restek/srapi 
SYNC missed versions from official npm registry.

StarRez API Wrapper for Node.js

This module (class) simplifies the process of implementing calls to StarRez's REST API by providing a few wrapper functions.

The module requires a file named sr-credentials.json in the project root (same directory as your main file). This file is not included, for security reasons. It should look something like:

{
  "user": "<your StarRez user name with API permissions>",
  "token": "abcdefg1234567"
}

You'll have to get the token from the StarRez web client. You cannot use your password.

Documentation is not complete.

Crash Course

The module exports a single class: SRAPI. You must instantiate an SRAPI object by passsing a boolean value indicating whether you want to use the production database. Otherwise, it defaults to the sandbox environment.

To use SRAPI, do something like this:

const SRAPI = require('./srapi/api');

const sr = new SRAPI(false);

sr.get('Entry', 6410).then((me) => {
  console.log(me.NameFirst);
}).catch(console.error);

Refer to the JSDocs for more information about the various methods.

Current Tags

  • 2.0.1                                ...           latest (a year ago)

17 Versions

  • 2.0.1                                ...           a year ago
  • 1.4.2                                ...           a year ago
  • 1.4.1                                ...           a year ago
  • 1.4.0                                ...           a year ago
  • 1.3.4                                ...           2 years ago
  • 1.3.2                                ...           2 years ago
  • 1.3.1                                ...           2 years ago
  • 1.2.1                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.8                                ...           2 years ago
  • 1.0.7                                ...           2 years ago
  • 1.0.6                                ...           2 years ago
  • 1.0.5                                ...           2 years ago
  • 1.0.4                                ...           2 years ago
  • 1.0.3                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 2
Last Month 11
Dependencies (3)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |