Integ Docs

Appearance

@happ-integ/keycrm ​

Клиент для KeyCRM API.

Установка ​

bash
pnpm add @happ-integ/keycrm

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

Инициализация ​

typescript
import { KeyCrmClient } from "@happ-integ/keycrm";

const keycrm = new KeyCrmClient(env.KEYCRM_API_KEY);

Контакты ​

typescript
// Создать контакт
const contact = await keycrm.createContact({
	first_name: "John",
	last_name: "Doe",
	phone: "+380501234567",
	email: "john@example.com",
});

// Поиск контактов
const results = await keycrm.searchContacts({
	query: "+380501234567",
});

// Обновить контакт
await keycrm.updateContact("123", {
	first_name: "Jane",
	status_id: "active",
});

// Получить контакт
const contact = await keycrm.getContact("123");

// Удалить контакт
await keycrm.deleteContact("123");

Сделки ​

typescript
// Создать сделку
const deal = await keycrm.createDeal({
	title: "Deal Title",
	contact_id: "123",
	status_id: "new",
	sum: 1000,
});

// Получить сделку
const deal = await keycrm.getDeal("456");

// Обновить сделку
await keycrm.updateDeal("456", {
	status_id: "won",
	sum: 1500,
});

Воронка продаж ​

typescript
// Получить статусы
const statuses = await keycrm.getStatuses();

// Получить категории
const categories = await keycrm.getCategories();

Health Check ​

typescript
const isHealthy = await keycrm.healthCheck();

API ​

KeyCrmClient ​

typescript
new KeyCrmClient(apiKey: string)

Параметр:

  • apiKey — KeyCRM API Key

Методы Контакты ​

createContact(params): Promise<IKeyContact> ​

searchContacts(params): Promise<IKeyContact[]> ​

updateContact(id, params): Promise<IKeyContact> ​

getContact(id): Promise<IKeyContact> ​

deleteContact(id): Promise<void> ​

Методы Сделки ​

createDeal(params): Promise<any> ​

getDeal(id): Promise<any> ​

updateDeal(id, params): Promise<any> ​

Методы Классификация ​

getStatuses(): Promise<any> ​

getCategories(): Promise<any> ​

healthCheck(): Promise<boolean> ​

Получить API Key ​

  1. https://app.keycrm.app/settings/integrations
  2. API
  3. Generate API Key
  4. Скопировать и добавить в Doppler / env
KEYCRM_API_KEY=xxxxx

API Documentation ​

https://keycrm.com/api

Когда использовать ​

  • ✅ Интеграция с KeyCRM
  • ✅ Управление контактами и сделками
  • ✅ Синхронизация данных