Ga naar inhoud

Endpointfamilies

De API wordt aangeboden door één gateway (api.rolchat.com) die elke padfamilie doorstuurt naar de service die er eigenaar van is. Deze pagina toont elke familie die de gateway voor klanten openstelt, gegroepeerd per module. Alle families delen de conventies - envelop, paginering, idempotentie, foutcodes - dus de tabel vertelt je waar een resource staat en hoe de aanroep wordt geauthenticeerd.

Paden zijn voorvoegsels: /api/v1/contacts dekt GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id enzovoort. Het langste voorvoegsel wint; daardoor kan een openbare subfamilie zoals /kb/public onder een geauthenticeerde /kb vallen.

GroepWie mag aanroepen
userAccountlid - JWT of API-sleutel, X-Account-Id verplicht
loginAnoniem, strenge inloglimieten (10 per IP-adres per minuut)
unauthenticatedAnoniem
widgetAnoniem, afgebakend op sitesleutel en origin (60 per site en IP-adres per minuut)
webhook-inboundOndertekend door de afzender - zie Webhooks
partnerPartner-JWT (partnerportaal)

Authenticatie en account

VoorvoegselServiceGroep
/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

Gesprekken en postvak IN

VoorvoegselServiceGroep
/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

VoorvoegselServiceGroep
/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

VoorvoegselServiceGroep
/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

Kanalen en widget

VoorvoegselServiceGroep
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Bezoekers

VoorvoegselServiceGroep
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Kennisbank

VoorvoegselServiceGroep
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

VoorvoegselServiceGroep
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Telefoon

VoorvoegselServiceGroep
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automatisering

VoorvoegselServiceGroep
/api/v1/automationautomation-serviceuser

Rapporten

VoorvoegselServiceGroep
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
VoorvoegselServiceGroep
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

VoorvoegselServiceGroep
/api/v1/aiplugin-serviceuser · time-out 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Meldingen

VoorvoegselServiceGroep
/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

VoorvoegselServiceGroep
/api/v1/mediamedia-serviceuser

Facturatie

VoorvoegselServiceGroep
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partnerportaal

VoorvoegselServiceGroep
/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

Identiteitsverificatie (KYC)

VoorvoegselServiceGroep
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Overig

VoorvoegselServiceGroep
/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

Deze tabel wordt gegenereerd uit de routetabel van de gateway in de backendrepository, als momentopname in deze site opgenomen. Een controle vóór elke deploy vergelijkt de momentopname met de huidige routetabel, zodat er geen familie in het product kan worden toegevoegd of verwijderd zonder dat deze pagina verandert. Interne routes van de medewerkersconsole zijn uitgesloten. Het machineleesbare OpenAPI-document wordt beschreven op de pagina OpenAPI.