rest-api-sdk-javascript

Hover API Rest SDK for JavaScript

Welcome to the Hover SDK for JavaScript, this SDK is for building a robust JavaScript application based on the Hover API. The Hover SDK for JavaScript makes it easy to integrate a full Hover API services into javascript (NodeJS) apps.

SDK Integration

In order to integrate the SDK into your node.js project follow the next steps:

• Add dependency 'thehover-rest-sdk' to your package.json file.

• Require 'thehover-rest-sdk' in your script

   	var thehover_sdk = require('thehover-rest-sdk');

• Configure SDK, by providing the required parameters:

   	thehover_sdk.configure({'endpoint':'127.0.0.1', 
   				'port':'80',
   				'api-version':'v1',
   				'ckey':'your-ckey'});

  All configure options available are:

  • connection_timeout - the timeout to wait a request
  • connection_readtimeout - the timeout to read response
  • endpoint - the dns or ip for The Hover API (default to our sandbox cloud)
  • port - the port for The Hover API (default to our sandbox)
  • api_version - the version of API (defualt v1)
  • ckey - your client secret token key to access the API
  • branch_id - the branch id of your SUPER BLUE USER
  • user_id - the user id of your SUPER BLUE USER

• Invoke API

   	thehover_sdk.profiles.fetch(profile, function(error, cb) {
       	    if (error) {
                	console.log(error);
               	throw error;
       	    } else {
               	console.log('Received response: ' + cb.response);
       	});

• Function Index

Function	Parameters
version	none
configure	options - a json with configurable options for the sdk
profiles.create	req_data - json, callback - function to return response
profiles.update	req_data - json, callback - function to return response
profiles.fetch	req_data - json, callback - function to return response
object.create	req_data - json, callback - function to return response
object.update	req_data - json, callback - function to return response
object.fetch	req_data - json, callback - function to return response
object.search {deprecated}	req_data - json, callback - function to return response
object.query	req_data - json, callback - function to return response
object.availability	req_data - json, callback - function to return response
object.isColor	req_data - json, callback - function to return response
object.login	req_data - json, callback - function to return response
object.changePassword	req_data - json, callback - function to return response
merge.create	req_data - json, callback - function to return response
merge.update	req_data - json, callback - function to return response
merge.fetch	req_data - json, callback - function to return response
notification.create	req_data - json, callback - function to return response
notification.update	req_data - json, callback - function to return response
notification.fetch	req_data - json, callback - function to return response
notification.fetchById	req_data - json, callback - function to return response
tags.create	req_data - json, callback - function to return response
tags.update	req_data - json, callback - function to return response
tags.fetch	req_data - json, callback - function to return response
nfc.assign	req_data - json, callback - function to return response
nfc.update	req_data - json, callback - function to return response
nfc.fetch	req_data - json, callback - function to return response
nfc.search	req_data - json, callback - function to return response
group.create	req_data - json, callback - function to return response
group.update	req_data - json, callback - function to return response
group.fetch	req_data - json, callback - function to return response
file.updload	req_data - json, callback - function to return response
file.fetch	req_data - json, callback - function to return response
geospatial.create	req_data - json, callback - function to return response
geospatial.update	req_data - json, callback - function to return response
geospatial.filter	req_data - json, callback - function to return response
metric.create	req_data - json, callback - function to return response
metric.fetch	req_data - json, callback - function to return response

• Function Deprecated Index

Function	Parameters
[metric.create_backward_compat] (https://jsapi.apiary.io/previews/hoverapi/reference/metrics/write)	req_data - json, callback - function to return response, it uses a deprecated /user/action
[metric.fetch_backward_compat] (https://jsapi.apiary.io/previews/hoverapi/reference/metrics/write)	req_data - json, callback - function to return response, it uses a deprecated /user/action

About

You can find more info about courses of how to use the API, SDKs or integration of The Hover into your app, visiting us at: http://www.thehover.com or mail us: thehover@hovanetworks.com