Rodiny endpointov
API obsluhuje jedna brána (api.rolchat.com), ktorá každú rodinu ciest smeruje k službe, ktorej patrí. Táto stránka uvádza všetky rodiny, ktoré brána sprístupňuje zákazníkom, zoskupené podľa modulov. Všetky rodiny zdieľajú rovnaké konvencie - obálku odpovede, stránkovanie, idempotenciu, chybové kódy - takže tabuľka hovorí, kde sa zdroj nachádza a ako sa volanie overuje.
Cesty sú prefixy: /api/v1/contacts pokrýva GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id a tak ďalej. Vyhráva najdlhší prefix, a preto môže verejná podrodina ako /kb/public ležať pod overovaným /kb.
Skupiny overovania
Section titled “Skupiny overovania”| Skupina | Kto smie volať |
|---|---|
user | Člen účtu - JWT alebo kľúč API, vyžaduje X-Account-Id |
login | Anonymne, prísne limity prihlásenia (10 z jednej IP za minútu) |
unauthenticated | Anonymne |
widget | Anonymne, obmedzené kľúčom webu a pôvodom (60 na web a IP za minútu) |
webhook-inbound | Podpísané odosielateľom - pozrite Webhooky |
partner | JWT partnera (partnerský portál) |
Rodiny
Section titled “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 |
Odkiaľ zoznam pochádza
Section titled “Odkiaľ zoznam pochádza”Táto tabuľka sa generuje z tabuľky trás brány v repozitári backendu, ktorej snímka je uložená v tomto webe. Kontrola pred každým nasadením porovnáva snímku s aktuálnou tabuľkou trás, takže v produkte nemožno pridať ani odobrať rodinu bez toho, aby sa zmenila táto stránka. Interné trasy konzoly zamestnancov sú vynechané. Strojovo čitateľný dokument OpenAPI opisuje stránka OpenAPI.