Endpoint ailələri

API hər yol ailəsini ona sahib olan xidmətə yönləndirən bir şlüz (api.rolchat.com) vasitəsilə təqdim olunur. Bu səhifə şlüzün müştərilərə açdığı hər ailəni modullar üzrə qruplaşdıraraq sadalayır. Bütün ailələr eyni qaydaları paylaşır - zərf, səhifələmə, idempotentlik, xəta kodları - ona görə də cədvəl resursun harada olduğunu və çağırışın necə autentifikasiya olunduğunu göstərir.

Yollar prefikslərdir: /api/v1/contacts GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id və s. əhatə edir. Ən uzun prefiks qalib gəlir, buna görə də /kb/public kimi açıq alt ailə autentifikasiyalı /kb altında yerləşə bilər.

Autentifikasiya qrupları

Qrup	Kim çağıra bilər
user	Account member - JWT or API key, X-Account-Id required
login	Anonymous, strict sign-in limits (10 per IP per minute)
unauthenticated	Anonymous
widget	Anonymous, scoped by site key and origin (60 per site and IP per minute)
webhook-inbound	Signed by the sender - see Webhooks
partner	Partner JWT (partner portal)

Ailələr

Auth & account

Prefix	Service	Bucket
/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

Prefix	Service	Bucket
/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

Prefix	Service	Bucket
/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

Prefix	Service	Bucket
/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

Prefix	Service	Bucket
/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

Prefix	Service	Bucket
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

Prefix	Service	Bucket
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Marketing

Prefix	Service	Bucket
/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

Prefix	Service	Bucket
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

Prefix	Service	Bucket
/api/v1/automation	automation-service	user

Reports

Prefix	Service	Bucket
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privacy & consent

Prefix	Service	Bucket
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Prefix	Service	Bucket
/api/v1/ai	plugin-service	user · 60 s timeout
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Notifications

Prefix	Service	Bucket
/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

Prefix	Service	Bucket
/api/v1/media	media-service	user

Billing

Prefix	Service	Bucket
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partner portal

Prefix	Service	Bucket
/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)

Prefix	Service	Bucket
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

Other

Prefix	Service	Bucket
/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

Siyahı haradan gəlir

Bu cədvəl backend repozitoriyasındakı şlüz marşrut cədvəlindən yaradılır və bu sayta snapshot kimi köçürülür. Hər yerləşdirmədən əvvəl yoxlama snapshot-u cari marşrut cədvəli ilə müqayisə edir, belə ki, bu səhifə dəyişmədən məhsulda ailə əlavə edilə və ya silinə bilməz. Daxili heyət konsolu marşrutları istisna edilir. Maşın tərəfindən oxunan OpenAPI sənədi OpenAPI səhifəsində təsvir olunub.