Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

megaplanjs

1.0.4 • Public • Published

Megaplan client module for NodeJS

A NodeJS library to work with megaplan.ru API ver. 1

Provides a class that implements Megaplan authentication and request signing. Only supports POST requests. The complete API documentation is at: https://dev.megaplan.ru/api/index.html

At first you need to install library

npm install megaplanjs --save

You can generate documentaion with commands:

npm install
npm run docs

Authorization

To authorize using a password:

var megaplan = require ('megaplanjs');
var client = new megaplan.Client('my.megaplan.ru').auth('me', 'pass');
client.on('auth', function (res, err) {
    // store res.access_id, res.secret_key if you need these (see below)
    console.log('authenticated', res, err);
 
    client.tasks().send(function (tasks) {
        console.log(tasks); // a lot of results
    }, function (err) {
        console.log(err);
    });
});

To authorize using tokens:

var megaplan = require ('megaplanjs');
var client = new megaplan.Client('xyz.megaplan.ru', access_id, secret_key);
client.tasks().send(function (tasks) {
    console.log(tasks); // still a lot of results
}, function (err) {
    console.log(err);
});

To authorize using one-time-key:

var megaplan = require ('megaplanjs');
var client = new megaplan.Client('xyz.megaplan.ru').auth('', '', '4gih4y4gih4yH77QebicH77Qebic');
client.tasks().send(function (tasks) {
    console.log(tasks); // still a lot of results
}, function (err) {
    console.log(err);
});

Usage

var megaplan = require("megaplanjs");
// SET here your megaplan URL, login and password
var client = new megaplan.Client("my.megaplan.ru").auth("me", "pass");
 
client.on("auth", function(res, err) {
  // show user's tasks
  client.tasks({ folder: "owner" }).send(
    function(tasks) {
      console.log(tasks);
    },
    function(err) {
      console.log(err);
    }
  );
});

Look index.js for more examples. It's pretty simple to use

Copylefts

Code originally written by Alexej Yaroshevich zxqfox@gmail.com under the MIT License.

Enjoy!

Install

npm i megaplanjs

DownloadsWeekly Downloads

16

Version

1.0.4

License

MIT

Unpacked Size

64.2 kB

Total Files

10

Last publish

Collaborators

  • avatar
  • avatar