Эндпоинттер топтары

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	Анонимді, қатаң кіру лимиттері (бір IP-ден минутына 10)
unauthenticated	Анонимді
widget	Анонимді, сайт кілті мен дереккөз бойынша шектелген (сайт пен IP-ге минутына 60)
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 бетінде сипатталған.