Famílias de endpoints

A API é servida por um único gateway (api.rolchat.com) que encaminha cada família de caminhos ao serviço responsável por ela. Esta página lista todas as famílias que o gateway expõe aos clientes, agrupadas por módulo. Todas as famílias seguem as mesmas convenções - envelope, paginação, idempotência, códigos de erro -, então a tabela mostra onde um recurso fica e como a chamada é autenticada.

Os caminhos são prefixos: /api/v1/contacts cobre GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id e assim por diante. O prefixo mais longo prevalece, e é por isso que uma subfamília pública como /kb/public pode ficar sob um /kb autenticado.

Grupos de autenticação

Grupo	Quem pode chamar
user	Membro da conta - JWT ou chave de API, X-Account-Id obrigatório
login	Anônimo, limites rígidos de login (10 por IP por minuto)
unauthenticated	Anônimo
widget	Anônimo, restrito pela chave do site e pela origem (60 por site e IP por minuto)
webhook-inbound	Assinado pelo remetente - veja Webhooks
partner	JWT de parceiro (portal de parceiros)

Famílias

Auth & account

Prefixo	Serviço	Grupo
/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

Prefixo	Serviço	Grupo
/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

Prefixo	Serviço	Grupo
/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

Prefixo	Serviço	Grupo
/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

Prefixo	Serviço	Grupo
/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

Prefixo	Serviço	Grupo
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

Prefixo	Serviço	Grupo
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Marketing

Prefixo	Serviço	Grupo
/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

Prefixo	Serviço	Grupo
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

Prefixo	Serviço	Grupo
/api/v1/automation	automation-service	user

Reports

Prefixo	Serviço	Grupo
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privacy & consent

Prefixo	Serviço	Grupo
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Prefixo	Serviço	Grupo
/api/v1/ai	plugin-service	user · tempo limite de 60 s
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Notifications

Prefixo	Serviço	Grupo
/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

Prefixo	Serviço	Grupo
/api/v1/media	media-service	user

Billing

Prefixo	Serviço	Grupo
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partner portal

Prefixo	Serviço	Grupo
/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)

Prefixo	Serviço	Grupo
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

Outros

Prefixo	Serviço	Grupo
/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

De onde vem a lista

Esta tabela é gerada a partir da tabela de rotas do gateway no repositório do backend, com um instantâneo copiado para este site. Uma verificação antes de cada deploy compara o instantâneo com a tabela de rotas atual, então uma família não pode ser adicionada ou removida no produto sem que esta página mude. As rotas internas do console da equipe ficam de fora. O documento OpenAPI legível por máquina é descrito na página OpenAPI.