Rodiny endpointů
API obsluhuje jedna brána (api.rolchat.com), která každou rodinu cest směruje ke službě, jíž patří. Tato stránka uvádí všechny rodiny, které brána zpřístupňuje zákazníkům, seskupené podle modulů. Všechny rodiny sdílejí stejné konvence - obálku odpovědi, stránkování, idempotenci, chybové kódy - takže tabulka říká, kde se zdroj nachází a jak se volání ověřuje.
Cesty jsou prefixy: /api/v1/contacts pokrývá GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id a tak dále. Vyhrává nejdelší prefix, a proto může veřejná podrodina jako /kb/public ležet pod ověřovaným /kb.
Skupiny ověřování
Sekce “Skupiny ověřování”| Skupina | Kdo smí volat |
|---|---|
user | Člen účtu - JWT nebo klíč API, vyžaduje X-Account-Id |
login | Anonymně, přísné limity přihlášení (10 z jedné IP za minutu) |
unauthenticated | Anonymně |
widget | Anonymně, omezeno klíčem webu a původem (60 na web a IP za minutu) |
webhook-inbound | Podepsáno odesílatelem - viz Webhooky |
partner | JWT partnera (partnerský portál) |
Rodiny
Sekce “Rodiny”Auth & account
| Prefix | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| Prefix | Služba | Skupina |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Prefix | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| Prefix | Služba | Skupina |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| Prefix | Služba | Skupina |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| Prefix | Služba | Skupina |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Prefix | Služba | Skupina |
|---|---|---|
/api/v1/ai | plugin-service | user · časový limit 60 s |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| Prefix | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| Prefix | Služba | Skupina |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| Prefix | Služba | Skupina |
|---|---|---|
/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 | Služba | Skupina |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Ostatní
| Prefix | Služba | Skupina |
|---|---|---|
/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 |
Odkud seznam pochází
Sekce “Odkud seznam pochází”Tato tabulka se generuje z tabulky tras brány v repozitáři backendu, jejíž snímek je uložen v tomto webu. Kontrola před každým nasazením porovnává snímek s aktuální tabulkou tras, takže v produktu nelze přidat ani odebrat rodinu, aniž by se změnila tato stránka. Interní trasy konzole zaměstnanců jsou vynechány. Strojově čitelný dokument OpenAPI popisuje stránka OpenAPI.