addrio-nodejs-sdk v1.2.3

addr.io nodejs sdk

installation

npm install addrio-nodejs-sdk --save

basic usage

var SDK = require("addrio-nodejs-sdk");
var sdk = new SDK(apitoken);
sdk.list(function(err, links) {
	if(err) {
		console.error(err);
		return;
	}
	console.info("you have " + links.length + " links!");
});

error handling

If something fails, the err parameter of the callback function includes an error object.

link object

A simple classification of a link with the following parameters:

• uuid (string)
• timestamp (date object)
• alias (string)
• url (string)
• deleted (boolean)
• temporary (boolean);

All the attributes are accessible using getters:

• getUUID()
• getTimestamp()
• getAlias()
• getURL()
• getDeleted()
• getTemporary()

And the following setters:

• setDeleted(boolean);
• setTemporary(boolean);

unauthenticated usage

You can construct the sdk object without passing an apikey. Without an apikey you can still create links, but they are not linked to your account. You also can't list links as you are not authenticated.

full reference

list links

var SDK = require("addrio-nodejs-sdk");
var sdk = new SDK(apitoken);
sdk.list(function(err, links) {
	if(err) { return console.error(err); };
	// list of links now available
});

create a link

var SDK = require("addrio-nodejs-sdk");
var sdk = new SDK(apitoken);
sdk.create("http://www.google.com", function(err, link) {
	if(err) { return console.error(err); };
	// link created
});

get a link

Will fetch a link instance with link uuid.

var SDK = require("addrio-nodejs-sdk");
var sdk = new SDK(apitoken);
sdk.find(guid, function(err, link) {
	if(err) { return console.error(err); };
	// link object available
});

update a link

You can manually edit some of the the link details and use this method to persist the changes. You can only change 'deleted' and 'temporary' flags.

var SDK = require("addrio-nodejs-sdk");
var sdk = new SDK(apitoken);
sdk.find(uuid, function(err, link) {
	if(err) { return console.error(err); };
	link.setTemporary(true);
	sdk.update(link, function(err, link) {
		if(err) { return console.error(err); };
		// now the link is updated
	});
});	

delete a link

Deleting a link means its deleted flag is set to TRUE and the link is not active anymore. A deleted link can be restored manually setting setDeleted(true) and using sdk.update(link) to persist the new status.

var SDK = require("addrio-nodejs-sdk");
var sdk = new SDK(apitoken);
sdk.find(uuid, function(err, link) {
	if(err) { return console.error(err); };
	link.setDeleted(true);
	sdk.update(link, function(err, link) {
		if(err) { return console.error(err); };
		// now the link is deleted
	});
});