Карта API

Общие правила

• Базовый префикс: /api/v2/crm.
• Все write endpoints требуют authenticated actor или service scope.
• Финансовые команды принимают Idempotency-Key и reason.
• Public storefront не пишет в CRM напрямую, а использует service endpoint для leads.
• Webhooks платёжных провайдеров проверяют подпись до изменения состояния.
• Ошибки возвращаются в общем API envelope.

Accounts

Endpoint	Метод	Permission	Назначение
/accounts	GET	crm.accounts.read	список карточек
/accounts	POST	crm.accounts.manage	создать карточку
/accounts/{accountId}	GET	crm.accounts.read	карточка
/accounts/{accountId}	PATCH	crm.accounts.manage	изменить карточку
/accounts/{accountId}/person-links	POST	crm.accounts.manage	связать человека
/accounts/{accountId}/contacts	POST	crm.contacts.manage	добавить контакт
/accounts/{accountId}/timeline	GET	crm.timeline.read	timeline

Sales

Endpoint	Метод	Permission	Назначение
/leads	GET/POST	crm.leads.read/manage	лиды
/service/leads/from-storefront	POST	service scope	лид из витрины
/leads/{leadId}/status	PATCH	crm.leads.manage	статус лида
/deals	GET/POST	crm.deals.read/manage	сделки
/deals/{dealId}/status	PATCH	crm.deals.manage	статус сделки
/orders	GET/POST	crm.orders.read/manage	заказы
/orders/{orderId}/confirm	POST	crm.orders.manage	подтвердить заказ

Billing

Endpoint	Метод	Permission	Назначение
/invoices	GET/POST	crm.billing.read/manage	счета
/invoices/{invoiceId}	GET	crm.billing.read	счёт
/invoices/{invoiceId}/issue	POST	crm.billing.manage	выставить
/payments	GET	crm.billing.read	платежи
/payments/provider-webhook/{provider}	POST	provider signature	webhook
/refunds	POST	crm.refunds.manage	создать возврат
/adjustments	POST	crm.adjustments.manage	ручная корректировка
/accounts/{accountId}/balance	GET	crm.billing.read	баланс

Entitlements

Endpoint	Метод	Permission	Назначение
/products	GET/POST	crm.products.read/manage	продукты
/products/{productId}/runs	GET/POST	crm.products.read/manage	запуски продукта
/price-plans	GET/POST	crm.products.read/manage	тарифы
/entitlements	GET/POST	crm.entitlements.read/manage	доступы
/entitlements/{id}	GET	crm.entitlements.read	карточка доступа
/entitlements/{id}/status	PATCH	crm.entitlements.manage	сменить статус
/entitlements/{id}/sync	POST	crm.entitlements.manage	отправить command в target domain
/entitlements/{id}/consumption	POST	crm.entitlements.consume	записать consumption от LMS/competitions

Support and interactions

Endpoint	Метод	Permission	Назначение
/interactions	GET/POST	crm.interactions.read/manage	коммуникации
/tickets	GET/POST	crm.tickets.read/manage	обращения
/tickets/{ticketId}/status	PATCH	crm.tickets.manage	статус обращения
/notes	POST	crm.notes.manage	заметка

Payroll

Endpoint	Метод	Permission	Назначение
/teacher-rates	GET/POST	crm.payroll.manage	ставки
/teacher-payouts	GET/POST	crm.payroll.read/manage	выплаты
/teacher-payouts/{id}/calculate	POST	crm.payroll.manage	расчёт
/teacher-payouts/{id}/approve	POST	crm.payroll.approve	утверждение
/me/teacher-payouts	GET	crm.payroll.read_self	свой расчёт

Admin

Endpoint	Метод	Permission	Назначение
/sync-logs	GET	crm.integrations.read	журнал синхронизации
/audit-logs	GET	crm.audit.read	аудит
/exports	POST	crm.exports.create	экспорт
/settings	GET/PATCH	crm.admin	настройки

Error codes

Код	HTTP	Когда
crm.account.not_found	404	карточка не найдена
crm.lead.duplicate	409	дубль лида по idempotency
crm.invoice.not_payable	409	счёт нельзя оплатить
crm.payment.signature_invalid	401	webhook signature invalid
crm.payment.duplicate_webhook	200	webhook уже обработан
crm.refund.amount_invalid	400	сумма возврата недопустима
crm.entitlement.source_required	400	доступ без основания
crm.financial.reason_required	400	нет причины корректировки
crm.financial.forbidden	403	нет доступа к финансам