allegro

Allegro.pl WebAPI client

npm install allegro
10 downloads in the last week
21 downloads in the last month

allegro.js

Allegro.pl WebAPI client for Node.js.

Build Status NPM version

Installation

npm install allegro

Usage

var allegro = require('allegro');

allegro.createClient({ key: 'your_webapi_key'}, function (err, client) {
    client.getUser(26729811, function (err, user) {
        console.log(user.login);
    });
});

API

allegro

createClient(options, callback)

Creates API client. Available options:

  • key - WebAPI key, can be generated in My Allegro (required),
  • countryId - country code, default: 1 (Poland)
  • login, passwords - credentials are needed to call some of methods (I don't know why but even for those not related to My Allegro) so, in most cases you should provide them. password can be replaced with passwordHash which is encoded in base64 sha-256 hash from password (base64(sha256(password))).

Callback function gets two arguments:

  • error - Error instance if error occured,
  • client - Client instance.

Example:

var allegro = require('allegro');

var options = {
    key: 'your_webapi_key',
    login: 'foo',
    password: 'bar'
};

allegro.createClient(options, function (error, client) {
    ...
});

Client

getCategory(categoryId, callback)

Get Category instance. Example:

allegro.createClient({ … }, function (error, client) {
    client.getCategory(149, function (error, category) {
        console.log(category.name); // 'Samochody' 
    });
});

getItem(itemId, callback)

Get Item instance. Example:

allegro.createClient({ … }, function (error, client) {
    client.getItem(3482560106, function (error, item) {
        console.log(item.name); // 'IGŁA BMW E90' 
    });
});

getUser(userId, callback)

Get User instance. Example:

allegro.createClient({ … }, function (error, client) {
    client.getUser(26729811, function (error, user) {
        console.log(user.login); // 'stendi_pl' 
    });
});

Events

  • buynow (itemId) - item is bought by 'Buy Now'. Example:
client.on('buynow', function (itemId) {
    console.log('Getting item:' + itemId
});

Category

Returned by client.getCategory.

Proporties

  • id int,
  • name string.

Item

Returned by client.getItem.

Proporties

  • id int,
  • name string.

Methods

  • getSeller(callback) get User instance of seller. Callback function gets Error and User instance. Example:
allegro.createClient({ … }, function (error, client) {
    client.getItem(3509260334, function (error, item) {
        item.getSeller(function(error, user) {
            console.log(user.login); // 'stendi_pl' 
        })
    });
});

User

Returned by client.getUser.

Proporties

  • id int,
  • login string,
  • rating int,
  • createdAt Date,
  • isAllegroStandrd bool.
npm loves you