No description, website, or topics provided.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.npm/package
client
server
tests
.gitignore
LICENSE
README.md
package.js
versions.json

README.md

meteor-blockscore

A Meteor wrapper for the BlockScore API.

Dependencies

TL;DR;

meteor-blockscore exposes the BlockScore API to your Meteor application.

Further information on the BlockScore API and its features is available at https://manage.blockscore.com/docs/index.

Installation

Install using Meteor:

$ meteor add resolver:blockscore

Put in your server's settings.json:

{
	"BlockScore": {
		"apiKey": "<Your BlockScore API Key>"
	}
}

and start your server with:

meteor --settings settings.json

Usage

BlockScore takes one argument - your API key, which you can find in your BlockScore Account.

All of the API categories and methods described in the BlockScore API Documentation (https://manage.blockscore.com/docs/index) are available in this wrapper both on the server and the client:

  • section The section of the API method to call (e.g. 'people').
  • method The method to call in the given section.
  • params Parameters to pass to the API method.
  • callback Callback function for returned data or errors with two parameters. The first one being an error object which is null when no error occured, the second one an object with all information retrieved as long as no error occured.

Example:

// You can as well pass different API key on each call
var blockScore = new BlockScore( /* apiKey */ );

blockScore.people.list( {}, function ( error, list ) {
	if ( error ) {
		console.error( '[BlockScore]: Error - %o', error );
	} else {
		console.info( '[BlockScore]: List of people - %o', list );
	}
});

Changelog

v0.1.1

  • Added test
  • Fixed bug with package publishing

v0.1.0

  • Initial release

Copyright and license

Copyright © 2014 Resolver

meteor-blockscore is licensed under the MIT license.