# affilitest

> AffiliTest's API implemented in JS for Node

Latest version **1.0.1** (published 2018-06-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install affilitest
pnpm add affilitest
yarn add affilitest
bun add affilitest
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-06-27 |
| First published | 2018-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yehonatan Tsirolnik |
| Maintainers | tsirolnik |

## Links

- npm: https://www.npmjs.com/package/affilitest
- Repository: https://github.com/tsirolnik/AffiliTest-JS
- Homepage: https://github.com/tsirolnik/AffiliTest-JS#readme
- Issues: https://github.com/tsirolnik/AffiliTest-JS/issues
- npm.io page: https://npm.io/package/affilitest

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.87.0

## Recent versions

- 1.0.1 (latest) — 2018-06-27
- 1.0.0 — 2018-06-27

## README

# AffiliTest-JS
AffilITest's API implementation in JS for the Node environment.

Tested with Node 8.11.1


## Basic usage
For full usage please refer to the [examples](examples/) directory
```js
    const { AffiliTestAPI, DEVICES } = require('affilitest');

    let affilitest = new AffilITestAPI();

    affilitest.login('email', 'password');

    // Passing the offer's URL, country code and device type
    // A custom device string can be passed too
    affilitest.test('http://example.com', 'us', DEVICES.ANDROID);
```

## Methods
AffiliTestAPI Class
### Login
`AffiliTestAPI.login(email, password)`
### Logout
`AffiliTestAPI.logout`
### Test
`AffiliTestAPI.test(url, country, device)`
### Compare To Preview
`AffiliTestAPI.compareToPreview(url, previewURL, country, device)`
### App Info
`AffiliTestAPI.appInfo(params)`
 * params.country - The app's country
 * params.url - The app's app store URL (Play Store or Appstore URL)
 * params.identifier - The app's package or id (Android Package or Appstore id)
### Calls left
`AffiliTestAPI.callsLeft`

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