Mga pamilya ng endpoint

Iisang gateway (api.rolchat.com) ang naghahatid ng API at niruruta nito ang bawat pamilya ng path sa serbisyong may-ari nito. Inililista ng pahinang ito ang bawat pamilyang inilalantad ng gateway sa mga customer, naka-grupo ayon sa module. Iisang mga kumbensyon ang sinusunod ng lahat ng pamilya - envelope, pagination, idempotency, mga error code - kaya sinasabi ng talahanayan kung saan nakatira ang isang resource at kung paano ina-authenticate ang tawag.

Mga prefix ang mga path: saklaw ng /api/v1/contacts ang GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id at iba pa. Nananaig ang pinakamahabang prefix, kaya puwedeng nasa ilalim ng authenticated na /kb ang pampublikong sub-family gaya ng /kb/public.

Mga bucket ng authentication

Bucket	Sino ang puwedeng tumawag
user	Miyembro ng account - JWT o API key, required ang X-Account-Id
login	Anonymous, mahigpit na limitasyon sa pag-sign in (10 kada IP kada minuto)
unauthenticated	Anonymous
widget	Anonymous, naka-scope sa site key at origin (60 kada site at IP kada minuto)
webhook-inbound	Naka-sign ng nagpadala - tingnan ang Mga webhook
partner	Partner JWT (partner portal)

Mga pamilya

Auth & account

Prefix	Serbisyo	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	Serbisyo	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	Serbisyo	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	Serbisyo	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	Serbisyo	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	Serbisyo	Bucket
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

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

Marketing

Prefix	Serbisyo	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	Serbisyo	Bucket
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

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

Reports

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

Privacy & consent

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

AI

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

Notifications

Prefix	Serbisyo	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	Serbisyo	Bucket
/api/v1/media	media-service	user

Billing

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

Partner portal

Prefix	Serbisyo	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	Serbisyo	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

Iba pa

Prefix	Serbisyo	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

Saan galing ang listahan

Nabubuo ang talahanayang ito mula sa route table ng gateway sa backend repository, na kinukuhanan ng snapshot papunta sa site na ito. Bago ang bawat deploy, ikinukumpara ng isang check ang snapshot sa kasalukuyang route table, kaya hindi puwedeng magdagdag o mag-alis ng pamilya sa produkto nang hindi nagbabago ang pahinang ito. Hindi kasama ang mga internal na ruta ng staff console. Inilalarawan ang machine-readable na OpenAPI document sa pahinang OpenAPI.