# theeye-client

> TheEye API Client

Latest version **0.9.8** (published 2016-09-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install theeye-client
pnpm add theeye-client
yarn add theeye-client
bun add theeye-client
```

## 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.9.8 |
| Published | 2016-09-16 |
| First published | 2016-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Facundo |
| Maintainers | facugon |
| Keywords | Theeye, Client |

## Links

- npm: https://www.npmjs.com/package/theeye-client
- Repository: https://github.com/interactar/theeye-client
- Homepage: https://github.com/interactar/theeye-client#readme
- Issues: https://github.com/interactar/theeye-client/issues
- npm.io page: https://npm.io/package/theeye-client

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) 2.2.0
- [request](https://npm.io/package/request.md) 2.55.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.9.8 (latest) — 2016-09-16
- 0.9.7 — 2016-09-15
- 0.9.6 — 2016-09-08
- 0.9.5 — 2016-08-30
- 0.9.4 — 2016-08-29
- 0.9.3 — 2016-08-25
- 0.9.2 — 2016-08-22
- 0.9.1 — 2016-08-20
- 0.9.0 — 2016-08-19

## README

# THEEYE-CLIENT

This client handle authentication steps required to connect the api(theeye-supervisor), so you do not have to worry about that.

## PreRequisites

Register in theeye.io, get a customer and credentials to connect.    
You will be able to connect directly using your username and password.        

## How to use.

The client main purpose is to stablish the connection with the supervisor. For that end it need the connection credentials.

There are two ways of passing connection credentials. One is with configuration options via constructor. 

Following parameters are required:

> api_url     
> client_customer       
> client_id (username)       
> client_secret (password)      

the `access_token` is optional. you can provide it if you have one.


```javascript
// initialize credentials
var options = {
  api_url: https://api.theeye.io,
  client_id: fulanito,
  client_secret: mipassword,
  client_customer: facugon,
  access_token: null
};

var client = new TheEye(options);
// client is ready to make a call
```

The other way is by defining connection credentials via shell environment.

> THEEYE_SUPERVISOR_API_URL    
> THEEYE_SUPERVISOR_CLIENT_ID    
> THEEYE_SUPERVISOR_CLIENT_SECRET    
> THEEYE_SUPERVISOR_CLIENT_CUSTOMER    

```sh
THEEYE_SUPERVISOR_API_URL='https://api.theeye.io' node ./yourscript.js
```

then in `yourscript.js` just `require` and then instantiate the client:

`const client = new TheEye();`

If all the necesary data is set and correct, `client` will be ready to make requests to the API.

See the example script in `example` directory

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