משפחות נקודות קצה

ה-API מוגש דרך שער אחד (api.rolchat.com) שמנתב כל משפחת נתיבים לשירות שבבעלותו היא. העמוד הזה מפרט כל משפחה שהשער חושף ללקוחות, מקובצת לפי מודול. כל המשפחות חולקות את המוסכמות - מעטפת, עימוד, אידמפוטנטיות, קודי שגיאה - כך שהטבלה אומרת לכם איפה משאב נמצא ואיך הקריאה מאומתת.

הנתיבים הם קידומות: /api/v1/contacts מכסה את GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id וכן הלאה. הקידומת הארוכה ביותר מנצחת, ולכן תת-משפחה ציבורית כמו /kb/public יכולה לשבת תחת /kb המאומתת.

קטגוריות אימות

קטגוריה	מי רשאי לקרוא
user	חבר בחשבון - JWT או מפתח API, X-Account-Id נדרשת
login	אנונימי, מגבלות התחברות מחמירות (10 לכל IP לדקה)
unauthenticated	אנונימי
widget	אנונימי, בהיקף מפתח האתר והמקור (60 לכל אתר ו-IP לדקה)
webhook-inbound	חתום על ידי השולח - ראו Webhooks
partner	JWT של שותף (פורטל השותפים)

משפחות

Auth & account

קידומת	שירות	קטגוריה
/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

קידומת	שירות	קטגוריה
/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

קידומת	שירות	קטגוריה
/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

קידומת	שירות	קטגוריה
/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

קידומת	שירות	קטגוריה
/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

קידומת	שירות	קטגוריה
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

קידומת	שירות	קטגוריה
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Marketing

קידומת	שירות	קטגוריה
/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

קידומת	שירות	קטגוריה
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

קידומת	שירות	קטגוריה
/api/v1/automation	automation-service	user

Reports

קידומת	שירות	קטגוריה
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privacy & consent

קידומת	שירות	קטגוריה
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

קידומת	שירות	קטגוריה
/api/v1/ai	plugin-service	user · זמן קצוב של 60 שנ'
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Notifications

קידומת	שירות	קטגוריה
/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

קידומת	שירות	קטגוריה
/api/v1/media	media-service	user

Billing

קידומת	שירות	קטגוריה
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partner portal

קידומת	שירות	קטגוריה
/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)

קידומת	שירות	קטגוריה
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

אחר

קידומת	שירות	קטגוריה
/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

מאיפה מגיעה הרשימה

הטבלה הזו נוצרת מטבלת הנתיבים של השער במאגר צד השרת, ותמונת מצב שלה נשמרת באתר הזה. בדיקה לפני כל פריסה משווה את תמונת המצב לטבלת הנתיבים הנוכחית, כך שאי אפשר להוסיף או להסיר משפחה במוצר בלי שהעמוד הזה ישתנה. נתיבים פנימיים של מסוף הצוות אינם נכללים. מסמך ה-OpenAPI הקריא למכונה מתואר בעמוד OpenAPI.