Salta ai contenuti

Famiglie di endpoint

L’API è servita da un unico gateway (api.rolchat.com) che instrada ogni famiglia di percorsi verso il servizio che la gestisce. Questa pagina elenca ogni famiglia che il gateway espone ai clienti, raggruppata per modulo. Tutte le famiglie condividono le convenzioni - envelope, paginazione, idempotenza, codici di errore - quindi la tabella ti dice dove si trova una risorsa e come viene autenticata la chiamata.

I percorsi sono prefissi: /api/v1/contacts copre GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id e così via. Vince il prefisso più lungo, ed è per questo che una sotto-famiglia pubblica come /kb/public può stare sotto un /kb autenticato.

CategoriaChi può chiamare
userMembro dell'account - JWT o chiave API, X-Account-Id obbligatorio
loginAnonimo, limiti di accesso rigidi (10 per IP al minuto)
unauthenticatedAnonimo
widgetAnonimo, limitato per chiave del sito e origine (60 per sito e IP al minuto)
webhook-inboundFirmato dal mittente - vedi Webhook
partnerJWT partner (portale partner)

Auth & account

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

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

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

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

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

Visitors

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

Knowledge base

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

Marketing

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

Phone

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

Automation

PrefissoServizioCategoria
/api/v1/automationautomation-serviceuser

Reports

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

AI

PrefissoServizioCategoria
/api/v1/aiplugin-serviceuser · timeout 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

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

PrefissoServizioCategoria
/api/v1/mediamedia-serviceuser

Billing

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

Partner portal

PrefissoServizioCategoria
/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)

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

Altro

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

Questa tabella è generata dalla tabella delle route del gateway nel repository del backend, salvata come snapshot in questo sito. Un controllo prima di ogni deploy confronta lo snapshot con la tabella delle route attuale, quindi una famiglia non può essere aggiunta o rimossa nel prodotto senza che questa pagina cambi. Le route interne della console dello staff sono escluse. Il documento OpenAPI leggibile dalle macchine è descritto nella pagina OpenAPI.