Integ Docs

Appearance

@happ-integ/salesdrive ​

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

Установка ​

bash
pnpm add @happ-integ/salesdrive

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

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

typescript
import { SalesdriveClient } from "@happ-integ/salesdrive";

const salesdrive = new SalesdriveClient(env.SALESDRIVE_API_KEY);

Контакты ​

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

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

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

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

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

Сделки ​

typescript
// Создать сделку
const deal = await salesdrive.createDeal({
	title: "New Deal",
	contact_id: "123",
	pipeline_id: "1",
	status_id: "1",
	amount: 5000,
});

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

// Обновить сделку
await salesdrive.updateDeal("456", {
	status_id: "2",
	amount: 6000,
});

// Удалить сделку
await salesdrive.deleteDeal("456");

Health Check ​

typescript
const isHealthy = await salesdrive.healthCheck();

API ​

SalesdriveClient ​

typescript
new SalesdriveClient(apiKey: string)

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

createContact(params): Promise<ISalesdriveContact> ​

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

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

getContact(id): Promise<ISalesdriveContact> ​

deleteContact(id): Promise<void> ​

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

createDeal(params): Promise<any> ​

getDeal(id): Promise<any> ​

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

deleteDeal(id): Promise<void> ​

Другое ​

healthCheck(): Promise<boolean> ​

Получить API Key ​

  1. https://app.salesdrive.me/settings
  2. API Settings
  3. Создать API Key
  4. Скопировать и добавить в Doppler / env
SALESDRIVE_API_KEY=xxxxx

API Documentation ​

https://api.salesdrive.me/docs

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

  • ✅ Интеграция с SalesDrive
  • ✅ CRM синхронизация
  • ✅ Pipeline управление