https://github.com/usefulweb/amocrm-account

AmoCRM Account Manager
https://github.com/usefulweb/amocrm-account

Last synced: about 2 months ago
JSON representation

AmoCRM Account Manager

• Host: GitHub
• URL: https://github.com/usefulweb/amocrm-account
• Owner: UsefulWeb
• License: mit
• Created: 2022-12-14T13:52:00.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-22T18:42:36.000Z (about 2 years ago)
• Last Synced: 2023-12-26T17:21:12.392Z (12 months ago)
• Language: TypeScript
• Size: 108 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AmoCRM Account

NodeJS библиотека для программного создания и получения списка аккаунтов AmoCRM.

Данный проект является экспериментальным и не рекомендуется для использования в production.

## Установка

Yarn:

```bash

yarn add --dev amocrm-account

```

npm:

```bash

npm i -D amocrm-account

```

## Использование

### Создание клиента

```javascript

import { Client } from 'amocrm-account';

const client = new Client({

    domain: 'amocrm.ru', // необязательный параметр, домен amocrm, по умолчанию amocrm.ru

    auth: {

        username: 'AmoCRM email',

        password: 'AmoCRM password'

    },

    session: '/home/amocrm/session.txt' // путь к файлу сессии. Хранит cookies авторизации

})

```

### Получение списка аккаунтов

```javascript

const accounts = await client.getAccounts(); // массив текущих аккаунтов, к которым пользователь имеет доступ

```

### Проверка аккаунта на существование

```javascript

// проверит, доступен ли для создания портал my-account.amocrm.ru

const result = await client.isAccountAvailable('my-account'); // false/true

```

### Создание аккаунта

```javascript

const result = await client.createAccount({

    subdomain: 'subdomain', // в итоге будет subdomain.amocrm.ru

    account_name: 'Account name' // имя аккаунта

});

```