Сімейства ендпоінтів

API обслуговує один шлюз (api.rolchat.com), який спрямовує кожне сімейство шляхів до сервісу, якому воно належить. На цій сторінці перелічено всі сімейства, які шлюз відкриває клієнтам, згруповані за модулями. Усі сімейства дотримуються спільних домовленостей - конверт, пагінація, ідемпотентність, коди помилок, - тож таблиця показує, де розташований ресурс і як автентифікується виклик.

Шляхи - це префікси: /api/v1/contacts охоплює GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id тощо. Перемагає найдовший префікс, тому публічне підсімейство, як-от /kb/public, може бути всередині автентифікованого /kb.

Класи автентифікації

Клас	Хто може викликати
user	Учасник акаунта - JWT або API-ключ, X-Account-Id обовʼязковий
login	Анонімно, суворі ліміти входу (10 з одного IP на хвилину)
unauthenticated	Анонімно
widget	Анонімно, обмежено ключем сайту та джерелом (60 на сайт і IP на хвилину)
webhook-inbound	Підписано відправником - див. Вебхуки
partner	Partner JWT (партнерський портал)

Сімейства

Auth & account

Префікс	Сервіс	Клас
/api/v1/auth	iam-service	login
/api/v1/captcha	iam-service	unauthenticated
/api/v1/me	iam-service	user
/api/v1/accounts	iam-service	user
/api/v1/account-settings	iam-service	user
/api/v1/users	iam-service	user
/api/v1/members	iam-service	user
/api/v1/roles	iam-service	user
/api/v1/tokens	iam-service	user
/api/v1/staff-access-policy	iam-service	user
/api/v1/staff-access-sessions	iam-service	user
/api/v1/presence	iam-service	user
/api/v1/workforce	iam-service	user
/api/v1/sites	sites-service	user
/api/v1/profile	profile-service	user
/api/v1/teams	teams-service	user
/api/v1/audit	audit-service	user

Conversations & inbox

Префікс	Сервіс	Клас
/api/v1/conversations	conversation-service	user
/api/v1/messages	conversation-service	user
/api/v1/conversation-tags	conversation-service	user
/api/v1/inboxes	conversation-service	user
/api/v1/views	conversation-service	user
/api/v1/templates	conversation-service	user
/api/v1/chat-routing-rules	conversation-service	user
/api/v1/macros	conversation-service	user
/api/v1/chat-settings	conversation-service	user
/api/v1/tasks	conversation-service	user

CRM

Префікс	Сервіс	Клас
/api/v1/leads	crm-service	user
/api/v1/contacts	crm-service	user
/api/v1/companies	crm-service	user
/api/v1/deals	crm-service	user
/api/v1/pipelines	crm-service	user
/api/v1/lead-statuses	crm-service	user
/api/v1/contact-tags	crm-service	user
/api/v1/segments	crm-service	user
/api/v1/lead-routing-rules	crm-service	user
/api/v1/crm-settings	crm-service	user
/api/v1/crm/campaigns	crm-service	user
/api/v1/custom-fields	meta-service	user

Tickets

Префікс	Сервіс	Клас
/api/v1/tickets	ticket-service	user
/api/v1/ticket-queues	ticket-service	user
/api/v1/ticket-settings	ticket-service	user
/api/v1/ticket-sla-policies	ticket-service	user
/api/v1/ticket-custom-fields	ticket-service	user
/api/v1/ticket-tags	ticket-service	user

Channels & widget

Префікс	Сервіс	Клас
/api/v1/channels	channel-service	user
/api/v1/widget-configs	channel-service	user
/api/v1/widget	visitor-service	widget
/api/v1/webhooks	channel-service	webhook-inbound

Visitors

Префікс	Сервіс	Клас
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

Префікс	Сервіс	Клас
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Marketing

Префікс	Сервіс	Клас
/api/v1/marketing	marketing-service	user
/api/v1/marketing/public	marketing-service	widget
/api/v1/surveys	marketing-service	user
/api/v1/survey-responses	marketing-service	user
/api/v1/meetings	marketing-service	user

Phone

Префікс	Сервіс	Клас
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

Префікс	Сервіс	Клас
/api/v1/automation	automation-service	user

Reports

Префікс	Сервіс	Клас
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privacy & consent

Префікс	Сервіс	Клас
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Префікс	Сервіс	Клас
/api/v1/ai	plugin-service	user · тайм-аут 60 s
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Notifications

Префікс	Сервіс	Клас
/api/v1/notifications-policy	notification-service	user
/api/v1/notifications	notification-service	user
/api/v1/notification-templates	notification-service	user
/api/v1/notification-delivery-logs	notification-service	user
/api/v1/push	notification-service	user

Media

Префікс	Сервіс	Клас
/api/v1/media	media-service	user

Billing

Префікс	Сервіс	Клас
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partner portal

Префікс	Сервіс	Клас
/api/v1/partner	partner-portal-service	partner
/api/v1/partner/auth	iam-service	login
/api/v1/partner/invitations	partner-portal-service	login
/api/v1/partner/auth/mfa/enroll	iam-service	partner
/api/v1/partner/auth/mfa/confirm	iam-service	partner
/api/v1/partner/auth/step-up	iam-service	partner
/api/v1/r	partner-portal-service	widget

Identity verification (KYC)

Префікс	Сервіс	Клас
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

Інше

Префікс	Сервіс	Клас
/api/v1/auth/me	iam-service	user
/api/v1/auth/sessions	iam-service	user
/api/v1/auth/mfa	iam-service	user
/api/v1/auth/email-change	iam-service	user
/api/v1/auth/swap-company	iam-service	user
/api/v1/privacy/policies	privacy-service	user
/api/v1/compliance	privacy-service	user
/api/v1/identity-graph	identity-graph-service	user

Звідки береться список

Ця таблиця генерується з таблиці маршрутів шлюзу в репозиторії бекенду й зберігається знімком на цьому сайті. Перевірка перед кожним деплоєм порівнює знімок із поточною таблицею маршрутів, тож сімейство не можна додати чи видалити в продукті без зміни цієї сторінки. Внутрішні маршрути консолі співробітників виключено. Машиночитний документ OpenAPI описано на сторінці OpenAPI.