1.0.0 • Published 1 year ago

amocrm-account v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

AmoCRM Account

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

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

Установка

Yarn:

yarn add --dev amocrm-account

npm:

npm i -D amocrm-account

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

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

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 авторизации
})

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

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

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

// проверит, доступен ли для создания портал my-account.amocrm.ru
const result = await client.isAccountAvailable('my-account'); // false/true

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

const result = await client.createAccount({
    subdomain: 'subdomain', // в итоге будет subdomain.amocrm.ru
    account_name: 'Account name' // имя аккаунта
});