dice-api

#Dice API

This library is used for making REST calls to the Dice platform. The Dice platform uses basic authentication. The username and password are passed at object instantiation a long with the host and path

Making requests

var DiceApi = require('dice-api');

// pass configurations
dice = new DiceApi({
	host: 'https://boggle.ice.com',	
	path: '/magento',
	username: 'username',
	password: 'password'
});

// make request
dice.reviews.add({
  product_id: 123,
  title: 'Hello WOrld',
  detail: 'Hello again, world',	
  nickname: 'duder',
  customer_id: 123,	
  star_rating: 5,
  ip_address: '127.0.0.1'
 }, function(response){	
  console.log(arguments);
  });

The above code will make a post request to 'https://boggle.ice.com/magento/reviews/add' sending the passed in object as the post body.

Adding new methods

New methods are in the ./src/magento directory. A new file should be created for each resource type (Product, Category, Customer, Cart etc). Inside each file will contain the method calls. Look in the ./src/magento/reviews.js file as a reference.

Inside the the file there is a protos object. This object contains sub objects that will map to the resource methods and define the request type, optional and required parameters.

var protos = {
    add: {
        verb: 'post', // request type
        mandatory: 'product_id,title,detail,nickname,star_rating,ip_address', // mandatory params
        optional: 'category_id' // optional params go here
    }
};

Configuring resources on the main Dice object

In ./src/dice.js you'll see a resources object

var resources = {
    reviews: './magento/reviews.js'
};

To add your newly created resource just add the resource name as the key and the file path to the resource.

In the above example, the resource name is 'reviews'. This resource is added to the Dice object and contains all of the declared in the resource js file.