Přeskočit na obsah

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.

SkupinaKdo smí volat
userČlen účtu - JWT nebo klíč API, vyžaduje X-Account-Id
loginAnonymně, přísné limity přihlášení (10 z jedné IP za minutu)
unauthenticatedAnonymně
widgetAnonymně, omezeno klíčem webu a původem (60 na web a IP za minutu)
webhook-inboundPodepsáno odesílatelem - viz Webhooky
partnerJWT partnera (partnerský portál)

Auth & account

PrefixSlužbaSkupina
/api/v1/authiam-servicelogin
/api/v1/captchaiam-serviceunauthenticated
/api/v1/meiam-serviceuser
/api/v1/accountsiam-serviceuser
/api/v1/account-settingsiam-serviceuser
/api/v1/usersiam-serviceuser
/api/v1/membersiam-serviceuser
/api/v1/rolesiam-serviceuser
/api/v1/tokensiam-serviceuser
/api/v1/staff-access-policyiam-serviceuser
/api/v1/staff-access-sessionsiam-serviceuser
/api/v1/presenceiam-serviceuser
/api/v1/workforceiam-serviceuser
/api/v1/sitessites-serviceuser
/api/v1/profileprofile-serviceuser
/api/v1/teamsteams-serviceuser
/api/v1/auditaudit-serviceuser

Conversations & inbox

PrefixSlužbaSkupina
/api/v1/conversationsconversation-serviceuser
/api/v1/messagesconversation-serviceuser
/api/v1/conversation-tagsconversation-serviceuser
/api/v1/inboxesconversation-serviceuser
/api/v1/viewsconversation-serviceuser
/api/v1/templatesconversation-serviceuser
/api/v1/chat-routing-rulesconversation-serviceuser
/api/v1/macrosconversation-serviceuser
/api/v1/chat-settingsconversation-serviceuser
/api/v1/tasksconversation-serviceuser

CRM

PrefixSlužbaSkupina
/api/v1/leadscrm-serviceuser
/api/v1/contactscrm-serviceuser
/api/v1/companiescrm-serviceuser
/api/v1/dealscrm-serviceuser
/api/v1/pipelinescrm-serviceuser
/api/v1/lead-statusescrm-serviceuser
/api/v1/contact-tagscrm-serviceuser
/api/v1/segmentscrm-serviceuser
/api/v1/lead-routing-rulescrm-serviceuser
/api/v1/crm-settingscrm-serviceuser
/api/v1/crm/campaignscrm-serviceuser
/api/v1/custom-fieldsmeta-serviceuser

Tickets

PrefixSlužbaSkupina
/api/v1/ticketsticket-serviceuser
/api/v1/ticket-queuesticket-serviceuser
/api/v1/ticket-settingsticket-serviceuser
/api/v1/ticket-sla-policiesticket-serviceuser
/api/v1/ticket-custom-fieldsticket-serviceuser
/api/v1/ticket-tagsticket-serviceuser

Channels & widget

PrefixSlužbaSkupina
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

PrefixSlužbaSkupina
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

PrefixSlužbaSkupina
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

PrefixSlužbaSkupina
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

PrefixSlužbaSkupina
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

PrefixSlužbaSkupina
/api/v1/automationautomation-serviceuser

Reports

PrefixSlužbaSkupina
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
PrefixSlužbaSkupina
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

PrefixSlužbaSkupina
/api/v1/aiplugin-serviceuser · časový limit 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

PrefixSlužbaSkupina
/api/v1/notifications-policynotification-serviceuser
/api/v1/notificationsnotification-serviceuser
/api/v1/notification-templatesnotification-serviceuser
/api/v1/notification-delivery-logsnotification-serviceuser
/api/v1/pushnotification-serviceuser

Media

PrefixSlužbaSkupina
/api/v1/mediamedia-serviceuser

Billing

PrefixSlužbaSkupina
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

PrefixSlužbaSkupina
/api/v1/partnerpartner-portal-servicepartner
/api/v1/partner/authiam-servicelogin
/api/v1/partner/invitationspartner-portal-servicelogin
/api/v1/partner/auth/mfa/enrolliam-servicepartner
/api/v1/partner/auth/mfa/confirmiam-servicepartner
/api/v1/partner/auth/step-upiam-servicepartner
/api/v1/rpartner-portal-servicewidget

Identity verification (KYC)

PrefixSlužbaSkupina
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Ostatní

PrefixSlužbaSkupina
/api/v1/auth/meiam-serviceuser
/api/v1/auth/sessionsiam-serviceuser
/api/v1/auth/mfaiam-serviceuser
/api/v1/auth/email-changeiam-serviceuser
/api/v1/auth/swap-companyiam-serviceuser
/api/v1/privacy/policiesprivacy-serviceuser
/api/v1/complianceprivacy-serviceuser
/api/v1/identity-graphidentity-graph-serviceuser

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.