brand24-api-nodejs v0.0.1

Node.js library for Brand24

This library is an API client for Brand24 services. Please contact brand24 team for API documentation. Some examples are decribed in this paper.

###Author & Contact

Piotr Athlan Pelczar - me@athlan.pl

Installation

###npm

npm install brand24-api-nodejs

###Define dependency in package.json

"require": {
    "brand24-api-nodejs": "*"
},

Usage instructions

GET request

To make GET request just use:

api.get('/endpoint', {
	urlparam1: 'urlvalue1'
}, function(err, result) {
	// ...
})

POST request

To make POST request just use:

api.post('/endpoint', {
	urlparam1: 'urlvalue1'
}, {
	postparam1: 'postvalue1'
}, function(err, result) {
	// ...
})

Examples

Get project info

var Brand24 = require('brand24-api-nodejs')

var accountId = 12345
var apiKey = 'xxx'

var client = Brand24.createClient(accountId, apiKey)
var api = Brand24.createTransport(client)

var projectId = 12345

api.get('/project-info', {
	sid: projectId
}, function(err, result) {
	
	if(null === err) {
		console.log("Project info:")
		console.log(require('util').inspect(result, true, 10))
	}
	else {
		console.log("Error occured:")
		console.log(err)
	}
})

Add project

var Brand24 = require('brand24-api-nodejs')

var accountId = 12345
var apiKey = 'xxx'

var client = Brand24.createClient(accountId, apiKey)
var api = Brand24.createTransport(client)

api.post('/project-add', {
}, {
	aid: accountId,
	name: 'Test project',
	"phrases_relevant": [
		"brand24"
	]
}, function(err, result) {
	
	if(null === err) {
		console.log("Project info:")
		console.log(require('util').inspect(result, true, 10))
	}
	else {
		console.log("Error occured:")
		console.log(err)
	}
})

Delete project

var Brand24 = require('brand24-api-nodejs')

var accountId = 12345
var apiKey = 'xxx'

var client = Brand24.createClient(accountId, apiKey)
var api = Brand24.createTransport(client)

var projectIdToDelete = 12345

api.get('/project-delete', {
	sid: projectIdToDelete,
	aid: accountId
}, function(err, result) {
	
	if(null === err) {
		console.log("Project info:")
		console.log(require('util').inspect(result, true, 10))
	}
	else {
		console.log("Error occured:")
		console.log(err)
	}
})

Get Mentions

var Brand24 = require('brand24-api-nodejs')

var accountId = 12345
var apiKey = 'xxx'

var client = Brand24.createClient(accountId, apiKey)
var api = Brand24.createTransport(client)

var projectId = 12345

api.get('/results', {
	sid: projectId,
	count: 15
}, function(err, result) {
	
	if(null === err) {
		console.log("Results:")
		console.log(require('util').inspect(result, true, 10))
	}
	else {
		console.log("Error occured:")
		console.log(err)
	}
})

Get Mentions Count

var Brand24 = require('brand24-api-nodejs')

var accountId = 12345
var apiKey = 'xxx'

var client = Brand24.createClient(accountId, apiKey)
var api = Brand24.createTransport(client)

var projectId = 12345

api.request('GET', '/results-count', {
	sid: projectId,
	d1: '2014-01-01',
	d2: '2014-01-30',
	group: 'day'
}, function(err, result) {
	
	if(null === err) {
		console.log("Results:")
		console.log(require('util').inspect(result, true, 10))
	}
	else {
		console.log("Error occured:")
		console.log(err)
	}
})