# npm-api-client-amocrm

> API Client for amoCRM

Latest version **0.6.3** (published 2018-04-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-api-client-amocrm
pnpm add npm-api-client-amocrm
yarn add npm-api-client-amocrm
bun add npm-api-client-amocrm
```

## 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.6.3 |
| Published | 2018-04-11 |
| First published | 2017-03-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Bolid1 |
| Maintainers | bolid1 |

## Links

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

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.81.0
- [underscore](https://npm.io/package/underscore.md) ^1.8.3

## Recent versions

- 0.6.3 (latest) — 2018-04-11
- 0.5.3 — 2017-05-23
- 0.5.2 — 2017-05-10
- 0.5.1 — 2017-05-10
- 0.5.0 — 2017-03-27
- 0.4.0 — 2017-03-24
- 0.3.1 — 2017-03-23
- 0.3.0 — 2017-03-23

## README

amoCRM API Client
=======

[![NPM](https://nodei.co/npm/npm-api-client-amocrm.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/npm-api-client-amocrm/)

An API client for amoCRM

Installation
----------------------

Supports Node.js 4.0.0 and later. You can install amoApiClient in your project's
`node_modules` folder, or you can install it globally.

To install the latest version available on NPM:

    npm install npm-api-client-amocrm

To install the latest development version:

    npm install git+https://github.com/Bolid1/npm-api-client-amocrm.git

Available methods and entities
----------------------
For contacts, leads, companies, tasks and notes available add, list, update and set methods.
For customers, transactions, catalogs and catalog elements available add, list, update, delete and set methods.
Also available method auth to auth in account and method current to get info about current account.

_Note:_
This client takes into account that amoCRM prohibits making requests to the API more than once per second.

Quick start
----------------------
```javascript
const amoClients = require('npm-api-client-amocrm');
const amoClient = amoClients.default();
const subdomain = 'test';
const login = 'test@test.test';
const key = 'test';

amoClient.auth(subdomain, login, key).then(function (res) {
  console.log('auth res: ', res);
  if (res.auth === true) {
    amoClient.addLeads([{name: 'Test'}]).then(function (leadsIds) {
      console.log('leadsIds: ', leadsIds);
      if (leadsIds[0] && leadsIds[0].id) {
        amoClient.listLeads({id: leadsIds[0].id}).then(function (leads) {
          console.log('lead: ', leads[0]);
        });
      }
    });
  }
});
```
Available methods and entities
----------------------
To know more go to

* [amoCRM home page](https://www.amocrm.ru)
* [API Reference](https://developers.amocrm.ru/)

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