Galapunktu saimes

API apkalpo viena vārteja (api.rolchat.com), kas maršrutē katru ceļu saimi uz servisu, kuram tā pieder. Šajā lapā ir uzskaitīta katra saime, ko vārteja nodrošina klientiem, sagrupēta pēc moduļiem. Visām saimēm ir kopīgas konvencijas - aploksne, lapošana, idempotence, kļūdu kodi -, tāpēc tabula pasaka, kur atrodas resurss un kā izsaukums tiek autentificēts.

Ceļi ir prefiksi: /api/v1/contacts aptver GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id un tā tālāk. Uzvar garākais prefikss, tāpēc publiska apakšsaime, piemēram, /kb/public, var atrasties zem autentificētas /kb.

Autentifikācijas grupas

Grupa	Kas drīkst izsaukt
user	Konta dalībnieks - JWT vai API atslēga, nepieciešama X-Account-Id
login	Anonīmi, stingri pieteikšanās ierobežojumi (10 no IP minūtē)
unauthenticated	Anonīmi
widget	Anonīmi, ierobežots ar vietnes atslēgu un izcelsmi (60 vietnei un IP minūtē)
webhook-inbound	Parakstījis sūtītājs - skatiet Webhooks
partner	Partnera JWT (partneru portāls)

Saimes

Autentifikācija un konts

Prefikss	Serviss	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

Sarunas un iesūtne

Prefikss	Serviss	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

Prefikss	Serviss	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

Pieteikumi

Prefikss	Serviss	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

Kanāli un logrīks

Prefikss	Serviss	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

Apmeklētāji

Prefikss	Serviss	Grupa
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Zināšanu bāze

Prefikss	Serviss	Grupa
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Mārketings

Prefikss	Serviss	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

Tālrunis

Prefikss	Serviss	Grupa
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automatizācija

Prefikss	Serviss	Grupa
/api/v1/automation	automation-service	user

Pārskati

Prefikss	Serviss	Grupa
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privātums un piekrišana

Prefikss	Serviss	Grupa
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Prefikss	Serviss	Grupa
/api/v1/ai	plugin-service	user · 60 s noildze
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Paziņojumi

Prefikss	Serviss	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

Multivide

Prefikss	Serviss	Grupa
/api/v1/media	media-service	user

Norēķini

Prefikss	Serviss	Grupa
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partneru portāls

Prefikss	Serviss	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

Identitātes verifikācija (KYC)

Prefikss	Serviss	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

Citi

Prefikss	Serviss	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

No kurienes nāk saraksts

Šī tabula tiek ģenerēta no vārtejas maršrutu tabulas aizmugursistēmas repozitorijā, un tās momentuzņēmums ir saglabāts šajā vietnē. Pārbaude pirms katras izvietošanas salīdzina momentuzņēmumu ar pašreizējo maršrutu tabulu, tāpēc saimi nevar pievienot vai noņemt produktā, nemainoties šai lapai. Iekšējās personāla konsoles maršruti ir izslēgti. Mašīnlasāmais OpenAPI dokuments ir aprakstīts lapā OpenAPI.