Lõpp-punktide perekonnad

API-d serveerib üks lüüs (api.rolchat.com), mis suunab iga teeperekonna teenusele, kellele see kuulub. See leht loetleb kõik perekonnad, mida lüüs klientidele avaldab, rühmitatuna mooduli järgi. Kõik perekonnad jagavad samu kokkuleppeid - ümbris, lehekülgedeks jaotamine, idempotentsus, veakoodid -, nii et tabel ütleb sulle, kus ressurss asub ja kuidas väljakutset autenditakse.

Teed on eesliited: /api/v1/contacts hõlmab GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id ja nii edasi. Võidab pikim eesliide, mistõttu avalik alamperekond, näiteks /kb/public, võib asuda autenditud /kb all.

Autentimisrühmad

Rühm	Kes võib välja kutsuda
user	Konto liige - JWT või API-võti, X-Account-Id on nõutav
login	Anonüümne, ranged sisselogimise piirangud (10 IP kohta minutis)
unauthenticated	Anonüümne
widget	Anonüümne, piiratud saidi võtme ja päritoluga (60 saidi ja IP kohta minutis)
webhook-inbound	Allkirjastatud saatja poolt - vaata Veebihaagid
partner	Partneri JWT (partneriportaal)

Perekonnad

Autentimine ja konto

Eesliide	Teenus	Rühm
/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

Vestlused ja postkast

Eesliide	Teenus	Rühm
/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

Eesliide	Teenus	Rühm
/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

Piletid

Eesliide	Teenus	Rühm
/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

Kanalid ja vidin

Eesliide	Teenus	Rühm
/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

Külastajad

Eesliide	Teenus	Rühm
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Teadmusbaas

Eesliide	Teenus	Rühm
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Turundus

Eesliide	Teenus	Rühm
/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

Telefon

Eesliide	Teenus	Rühm
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automatiseerimine

Eesliide	Teenus	Rühm
/api/v1/automation	automation-service	user

Aruanded

Eesliide	Teenus	Rühm
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privaatsus ja nõusolek

Eesliide	Teenus	Rühm
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Eesliide	Teenus	Rühm
/api/v1/ai	plugin-service	user · 60 s ajalõpp
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Teavitused

Eesliide	Teenus	Rühm
/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

Meedia

Eesliide	Teenus	Rühm
/api/v1/media	media-service	user

Arveldus

Eesliide	Teenus	Rühm
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partneriportaal

Eesliide	Teenus	Rühm
/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

Isikusamasuse kontroll (KYC)

Eesliide	Teenus	Rühm
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

Muu

Eesliide	Teenus	Rühm
/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

Kust loend pärineb

See tabel genereeritakse taustsüsteemi repositooriumis olevast lüüsi marsruutide tabelist, millest on sellele saidile tehtud hetktõmmis. Kontroll enne iga juurutamist võrdleb hetktõmmist praeguse marsruutide tabeliga, nii et tootes ei saa perekonda lisada ega eemaldada ilma selle lehe muutumiseta. Töötajate sisekonsooli marsruudid on välja jäetud. Masinloetavat OpenAPI dokumenti kirjeldab leht OpenAPI.