Rodziny endpointów

API jest obsługiwane przez jedną bramę (api.rolchat.com), która kieruje każdą rodzinę ścieżek do usługi, do której ona należy. Ta strona wymienia każdą rodzinę, którą brama udostępnia klientom, pogrupowaną według modułów. Wszystkie rodziny stosują te same konwencje - koperta odpowiedzi, paginacja, idempotentność, kody błędów - więc tabela mówi, gdzie znajduje się zasób i jak uwierzytelniane jest wywołanie.

Ścieżki są prefiksami: /api/v1/contacts obejmuje GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id i tak dalej. Wygrywa najdłuższy prefiks, dlatego publiczna podrodzina, taka jak /kb/public, może znajdować się pod uwierzytelnianym /kb.

Grupy uwierzytelniania

Grupa	Kto może wywoływać
user	Członek konta - JWT lub klucz API, wymagany X-Account-Id
login	Anonimowo, ścisłe limity logowania (10 na IP na minutę)
unauthenticated	Anonimowo
widget	Anonimowo, w zakresie klucza strony i pochodzenia (60 na stronę i IP na minutę)
webhook-inbound	Podpisane przez nadawcę - zobacz Webhooki
partner	JWT partnera (portal partnera)

Rodziny

Auth & account

Prefiks	Usługa	Grupa
/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

Prefiks	Usługa	Grupa
/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

Prefiks	Usługa	Grupa
/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

Prefiks	Usługa	Grupa
/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

Prefiks	Usługa	Grupa
/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

Prefiks	Usługa	Grupa
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

Prefiks	Usługa	Grupa
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Marketing

Prefiks	Usługa	Grupa
/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

Prefiks	Usługa	Grupa
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

Prefiks	Usługa	Grupa
/api/v1/automation	automation-service	user

Reports

Prefiks	Usługa	Grupa
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privacy & consent

Prefiks	Usługa	Grupa
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Prefiks	Usługa	Grupa
/api/v1/ai	plugin-service	user · limit czasu 60 s
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Notifications

Prefiks	Usługa	Grupa
/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

Prefiks	Usługa	Grupa
/api/v1/media	media-service	user

Billing

Prefiks	Usługa	Grupa
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partner portal

Prefiks	Usługa	Grupa
/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)

Prefiks	Usługa	Grupa
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

Inne

Prefiks	Usługa	Grupa
/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

Skąd pochodzi lista

Ta tabela jest generowana z tabeli tras bramy w repozytorium backendu, której migawka jest zapisana w tej witrynie. Kontrola przed każdym wdrożeniem porównuje migawkę z aktualną tabelą tras, więc w produkcie nie można dodać ani usunąć rodziny bez zmiany tej strony. Wewnętrzne trasy konsoli personelu są pominięte. Dokument OpenAPI w formacie do odczytu maszynowego jest opisany na stronie OpenAPI.