NodeJS библиотека для работы с AmoCRM.
:warning: Изменился способ подключения основного класса библиотеки
Было:
const Client = require('amocrm-js');
Стало
const { Client } = require('amocrm-js');
:warning: В целях обратной совместимости старый способ работает. В будущих версиях он будет убран
Документация: https://usefulweb.github.io/AmoCRM
Не предназначена для Frontend приложений
Поддерживает OAuth авторизацию и использует адреса AmoCRM API v4.
Сделайте библиотеку самой популярной в Галактике - поставьте Star ★!
По вопросам сотрудничества и проектам пишите в Telegram.
По всем вопросам работы библиотеки заходите в чат проекта в Telegram. Сделаем вместе пространство уютным :)
npm
npm install amocrm-js
Yarn
yarn add amocrm-js
const { Client } = require('amocrm-js');
ES6:
import { Client } from 'amocrm-js'
Подключение возможно:
После успешного подключения клиент автоматически получает новый токен по истечению старого перед формированием запроса
Его можно получить с помощью упрощенной авторизации или самостоятельно написанного обработчика адреса интеграции (redirectUri).
const client = new Client({
// логин пользователя в портале, где адрес портала domain.amocrm.ru
domain: 'domain', // может быть указан полный домен вида domain.amocrm.ru, domain.amocrm.com
/*
Информация об интеграции (подробности подключения
описаны на https://www.amocrm.ru/developers/content/oauth/step-by-step)
*/
auth: {
client_id: 'clientId', // ID интеграции
client_secret: 'clientSecret', // Секретный ключ
redirect_uri: 'redirectUri', // Ссылка для перенаправления
code: 'code', // Код для упрощённой авторизации, необязательный
},
});
В AmoCRM API код авторизации можно использовать только один раз для получения токена. Последующие запросы на получение токена будут выдавать ошибку.
Чтобы облегчить процесс получения токена, в данный пакет встроен OAuth-сервер, который может обрабатывать указанный адрес перенаправления. Сервер включает прослушивание по необходимости и закрывает соединение по получению кода авторизации.
Пример настройки без параметра code:
const client = new Client({
// логин пользователя в портале, где адрес портала domain.amocrm.ru
domain: 'domain', // может быть указан полный домен вида domain.amocrm.ru, domain.amocrm.com
/*
Информация об интеграции (подробности подключения
описаны на https://www.amocrm.ru/developers/content/oauth/step-by-step)
*/
auth: {
client_id: 'clientId', // ID интеграции
client_secret: 'clientSecret', // Секретный ключ
redirect_uri: 'redirectUri', // Ссылка для перенаправления,
/*
Необязательный араметр состояния для проверки на корректность.
Используется встроенным сервером авторизации.
см. https://www.amocrm.ru/developers/content/oauth/step-by-step#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-Authorization-code
*/
state: 'state',
server: {
// порт, на котором запустится сервер авторизации
port: 3000
}
},
});
Один из простых способ разработки интеграции: библиотека-сервис ngrok. Пакет перенаправляет трафик с вашего компьютера на заданный публичный IP, который можно задать в адресе интеграции.
Для работы сервера авторизации на «боевом» хостинге ему нужно выполнение условий:
После остаётся только заменить адрес {redirectUri} на адрес вашего хоста в настройках библиотеки и интеграции.
const client = new Client({
// ...
auth: {
// ...
redirect_uri: 'redirectUri',
server: {
port: 3001
}
},
});
Фабрики позволяют управлять порталом в ООП стиле.
const lead = new client.Lead;
lead.name = 'Евгений Иванов';
await lead.save();
const lead = client.leads.getById(123);
lead.name = 'Walter Scott';
await lead.save();
const pagination = await client.leads.get({
order: 'created_at',
});
const leads = pagination.getData();
await pagination.next();
В настоящий момент библиотека поддерживает фабрики:
С указанием метода:
const result = await client.request.make('GET', '/api/v4/account');
// возвращает тело ответа
console.log(result.data);
/*
Возвращает расширенную информацию об ответе -
экземпляр http.IncomingMessage:
https://nodejs.org/api/http.html#class-httpincomingmessage
*/
console.log(result.response);
// к примеру, HTTP-статус ответа операции
console.log(result.response.statusCode);
const response = await client.request.get('/api/v4/contacts')
С помощью querystring:
const response = await client.request.get('/api/v4/contacts?with=version');
объектом:
const response = await client.request.get('/api/v4/contacts', {
with: 'version'
});
const response = await client.request.post('/api/v4/contacts', [
{
name: "Walter White",
request_id: 143,
// другие поля ...
}
]
);
const response = await client.request.patch( '/api/v4/leads', [
{
"id": 54886,
"pipeline_id": 47521,
"status_id": 143,
"date_close": 1589297221,
"loss_reason_id": 7323,
"updated_by": 0
}
]
)
В нём хранятся все переданные ранее настройки
Получить настройки, переданные конструктору Client
const { Client } = require('amocrm-js');
const client = new Client({
// логин пользователя в портале, где адрес портала domain.amocrm.ru
domain: 'domain', // может быть указан полный домен вида domain.amocrm.ru, domain.amocrm.com
/*
Информация об интеграции (подробности подключения
описаны на https://www.amocrm.ru/developers/content/oauth/step-by-step)
*/
auth: {
client_id: 'clientId', // ID интеграции
client_secret: 'clientSecret', // Секретный ключ
redirect_uri: 'redirectUri', // Ссылка для перенаправления
code: 'code', // Код для упрощённой авторизации, необязательный
/*
Параметр состояния для проверки на корректность. Необязательный. Используется встроенным сервером авторизации
см. https://www.amocrm.ru/developers/content/oauth/step-by-step#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-Authorization-code
*/
state: 'state',
},
});
client.environment.get(); // возвращает весь объект настроек
client.environment.get('domain'); // 'domain';
client.environment.get('auth.redirect_uri'); // 'redirectUri'
Устанавливает новое значение в окружении
client.environment.set('auth.state', 'newsState');
Получает токен на основе (в зависимости от ситуации):
client.connection.on('connectionError', () => {
console.error('Произошла ошибка соединения');
})
Возвращает адрес ссылки на портал AmoCRM, по которой должен перейти пользователь для получения кода авторизации.
Параметр mode отвечает за обработку запроса на Redirect URI.
Устанавливает код авторизации и удаляет информацию о текущем токене. Желательно применять именно этот метод в сравнение с client.environment.set('auth.code');
Устанавливает новое значение токена.
Возвращает текущее значение токена.
Обновляет токен по значению refresh_token текущего. Явно вызывать нет необходимости, так как при каждом запросе идёт проверка токена на актуальность. Если время жизни токена истекло, этот метод будет вызван автоматически.
После обновления, токен автоматически устанавливается в приложении.
Получение токена по коду авторизации. После обновления, токен автоматически устанавливается в приложении.
client.connection.on('change', () => {
console.error('Токен обновлён');
})
Компоненты Auth, Token, Connection унаследованы от класса EventEmitter. То есть они все поддерживают методы подписки на события (on, off, removeAllListeners) и отписки от них, принятые в EventEmitter.
Может быть полезным сохранять авторизацию между запусками приложения. Для этого есть событие change
компонента client.token, в которое приходит новый токен при каждом сохранении.
Этот токен можно сохранять куда вам удобно (БД, файлы и тд). При инициализации соединения можно заранее установить токен для восстановления авторизации:
crm.token.setValue(currentToken)
Ниже пример реализации через сохранение в файл token.json который лежит рядом со скриптом
client.connection.on('change', () => {
const token = client.token.getValue();
fs.writeFileSync('./token.js', JSON.stringify(token));
});
try {
const currentToken = require('./token.js');
client.token.setValue(currentToken);
} catch (e) {
// Файл не найден
}
Замена: client.auth.setCode(code)
Вызов этого метода в версии 2.x.x приводит к обновлению токена по только что заданному коду.
В текущей версии это происходит при последующем запросе к API. Старая версия эквивалентна:
client.auth.setCode(code);
await client.connection.connect();
Спасибо @amorev, @maxism, @shuraman69 за вклад в разработку этого проекта
Отдельная благодарность @dmitrytemlead за возможность протестировать библиотеку в стороннем проекте
FAQs
JS Library for AmoCRM
The npm package amocrm-js receives a total of 513 weekly downloads. As such, amocrm-js popularity was classified as not popular.
We found that amocrm-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."