Galinių taškų šeimos

API pateikia vienas šliuzas (api.rolchat.com), kuris kiekvieną kelių šeimą nukreipia į ją valdančią tarnybą. Šiame puslapyje išvardyta kiekviena šeima, kurią šliuzas pateikia klientams, sugrupuota pagal modulius. Visos šeimos laikosi tų pačių konvencijų - apvalkalo, puslapiavimo, idempotentiškumo, klaidų kodų - todėl lentelė parodo, kur yra išteklius ir kaip autentifikuojamas iškvietimas.

Keliai yra priešdėliai: /api/v1/contacts apima GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id ir t. t. Laimi ilgiausias priešdėlis, todėl vieša pošeimė, tokia kaip /kb/public, gali būti po autentifikuota /kb.

Autentifikavimo grupės

Grupė	Kas gali kviesti
user	Paskyros narys - JWT arba API raktas, būtina X-Account-Id
login	Anoniminis, griežti prisijungimo limitai (10 vienam IP per minutę)
unauthenticated	Anoniminis
widget	Anoniminis, apribotas svetainės raktu ir kilme (60 svetainei ir IP per minutę)
webhook-inbound	Pasirašytas siuntėjo - žr. Webhook'ai
partner	Partnerio JWT (partnerių portalas)

Šeimos

Autentifikavimas ir paskyra

Priešdėlis	Tarnyba	Grupė
/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

Pokalbiai ir gautųjų dėžutė

Priešdėlis	Tarnyba	Grupė
/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

Priešdėlis	Tarnyba	Grupė
/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

Užklausos

Priešdėlis	Tarnyba	Grupė
/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

Kanalai ir valdiklis

Priešdėlis	Tarnyba	Grupė
/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

Lankytojai

Priešdėlis	Tarnyba	Grupė
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Žinių bazė

Priešdėlis	Tarnyba	Grupė
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Rinkodara

Priešdėlis	Tarnyba	Grupė
/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

Telefonas

Priešdėlis	Tarnyba	Grupė
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automatizavimas

Priešdėlis	Tarnyba	Grupė
/api/v1/automation	automation-service	user

Ataskaitos

Priešdėlis	Tarnyba	Grupė
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privatumas ir sutikimai

Priešdėlis	Tarnyba	Grupė
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Priešdėlis	Tarnyba	Grupė
/api/v1/ai	plugin-service	user · 60 s laiko limitas
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Pranešimai

Priešdėlis	Tarnyba	Grupė
/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

Medija

Priešdėlis	Tarnyba	Grupė
/api/v1/media	media-service	user

Atsiskaitymai

Priešdėlis	Tarnyba	Grupė
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partnerių portalas

Priešdėlis	Tarnyba	Grupė
/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

Tapatybės patikrinimas (KYC)

Priešdėlis	Tarnyba	Grupė
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

Kita

Priešdėlis	Tarnyba	Grupė
/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

Iš kur gaunamas sąrašas

Ši lentelė sugeneruota iš šliuzo maršrutų lentelės serverio repozitorijoje, kurios momentinė kopija įrašyta į šią svetainę. Patikra prieš kiekvieną diegimą palygina kopiją su dabartine maršrutų lentele, todėl šeimos negalima pridėti ar pašalinti produkte nepasikeitus šiam puslapiui. Vidiniai darbuotojų konsolės maršrutai neįtraukiami. Mašinai skaitomas OpenAPI dokumentas aprašytas puslapyje OpenAPI.