# thehover-rest-sdk

> SDK Bindings for Javascript (Node JS)

Latest version **0.2.8** (published 2017-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install thehover-rest-sdk
pnpm add thehover-rest-sdk
yarn add thehover-rest-sdk
bun add thehover-rest-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.8 |
| Published | 2017-01-07 |
| First published | 2015-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | The Hover Cloud Programming Engine Inc |
| Maintainers | thehover |
| Keywords | thehover, sdk, api, query language |

## Links

- npm: https://www.npmjs.com/package/thehover-rest-sdk
- Repository: https://github.com/TheHover/rest-api-sdk-javascript
- Issues: https://github.com/TheHover/rest-api-sdk-javascript/issues
- npm.io page: https://npm.io/package/thehover-rest-sdk

## Dependencies (1)

- [form-data](https://npm.io/package/form-data.md) *

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 0.2.8 (latest) — 2017-01-07
- 0.2.7 — 2017-01-07
- 0.2.6 — 2016-12-10
- 0.2.4 — 2016-08-31
- 0.2.3 — 2016-08-31
- 0.2.2 — 2016-05-31
- 0.2.1 — 2016-04-20
- 0.1.12 — 2016-02-17
- 0.1.11 — 2016-02-17
- 0.1.10 — 2015-07-22
- 0.1.9 — 2015-07-22
- 0.1.8 — 2015-07-03
- 0.1.7 — 2015-07-03
- 0.1.6 — 2015-07-03
- 0.1.5 — 2015-07-03
- … 5 more at https://npm.io/package/thehover-rest-sdk/versions

## README

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

	```javascript
		var thehover_sdk = require('thehover-rest-sdk');
	```
	
* Configure SDK, by providing the required parameters:

	```javascript
		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

	```javascript
		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](#version)** | none | returns sdk version
**[configure](#configure)** | options - a json with configurable options for the sdk | configure env for sdk
**[profiles.create](http://docs.hoverapi.apiary.io/#profiles)** | req_data - json, callback - function to return response
**[profiles.update](http://docs.hoverapi.apiary.io/#profiles)** | req_data - json, callback - function to return response
**[profiles.fetch](http://docs.hoverapi.apiary.io/#profiles)** | req_data - json, callback - function to return response
**[object.create](http://docs.hoverapi.apiary.io/#user)** | req_data - json, callback - function to return response
**[object.update](http://docs.hoverapi.apiary.io/#user)** | req_data - json, callback - function to return response
**[object.fetch](http://docs.hoverapi.apiary.io/#user)** | req_data - json, callback - function to return response
**[object.search {deprecated}](http://docs.hoverapi.apiary.io/#search)** | req_data - json, callback - function to return response
**[object.query](http://docs.hoverapi.apiary.io/#usersearchthql)** | req_data - json, callback - function to return response
**[object.availability](http://docs.hoverapi.apiary.io/#useravailability)** | req_data - json, callback - function to return response
**[object.isColor](http://docs.hoverapi.apiary.io/#usercolor)** | req_data - json, callback - function to return response
**[object.login](http://docs.hoverapi.apiary.io/#userlogin)** | req_data - json, callback - function to return response
**[object.changePassword](http://docs.hoverapi.apiary.io/#userloginchangepassword)** | req_data - json, callback - function to return response
**[merge.create](http://docs.hoverapi.apiary.io/#usermerge)** | req_data - json, callback - function to return response
**[merge.update](http://docs.hoverapi.apiary.io/#usermerge)** | req_data - json, callback - function to return response
**[merge.fetch](http://docs.hoverapi.apiary.io/#usermerge)** | req_data - json, callback - function to return response
**[notification.create](http://docs.hoverapi.apiary.io/#usernotifications)** | req_data - json, callback - function to return response
**[notification.update](http://docs.hoverapi.apiary.io/#usernotifications)** | req_data - json, callback - function to return response
**[notification.fetch](http://docs.hoverapi.apiary.io/#usernotifications)** | req_data - json, callback - function to return response
**[notification.fetchById](http://docs.hoverapi.apiary.io/#usernotifications)** | req_data - json, callback - function to return response
**[tags.create](http://docs.hoverapi.apiary.io/#usertags)** | req_data - json, callback - function to return response
**[tags.update](http://docs.hoverapi.apiary.io/#usertags)** | req_data - json, callback - function to return response
**[tags.fetch](http://docs.hoverapi.apiary.io/#usertags)** | req_data - json, callback - function to return response
**[nfc.assign](http://docs.hoverapi.apiary.io/#usernfccard)** | req_data - json, callback - function to return response
**[nfc.update](http://docs.hoverapi.apiary.io/#usernfccard)** | req_data - json, callback - function to return response
**[nfc.fetch](http://docs.hoverapi.apiary.io/#usernfccard)** | req_data - json, callback - function to return response
**[nfc.search](http://docs.hoverapi.apiary.io/#searchnfc)** | req_data - json, callback - function to return response
**[group.create](http://docs.hoverapi.apiary.io/#groups)** | req_data - json, callback - function to return response
**[group.update](http://docs.hoverapi.apiary.io/#groups)** | req_data - json, callback - function to return response
**[group.fetch](http://docs.hoverapi.apiary.io/#groups)** | req_data - json, callback - function to return response
**[file.updload](http://docs.hoverapi.apiary.io/#userfile)** | req_data - json, callback - function to return response
**[file.fetch](http://docs.hoverapi.apiary.io/#userfile)** | req_data - json, callback - function to return response
**[geospatial.create](http://docs.hoverapi.apiary.io/#reference/geospatial)** | req_data - json, callback - function to return response
**[geospatial.update](http://docs.hoverapi.apiary.io/#reference/geospatial)** | req_data - json, callback - function to return response
**[geospatial.filter](http://docs.hoverapi.apiary.io/#reference/geospatial)** | req_data - json, callback - function to return response
**[metric.create](http://docs.hoverapi.apiary.io/#useraction)** | req_data - json, callback - function to return response
**[metric.fetch](http://docs.hoverapi.apiary.io/#useraction)** | 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

---
_Source: https://npm.io/package/thehover-rest-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._