Aller au contenu

Familles d'endpoints

L’API est servie par une passerelle unique (api.rolchat.com) qui achemine chaque famille de chemins vers le service qui en est responsable. Cette page liste chaque famille que la passerelle expose aux clients, regroupée par module. Toutes les familles partagent les conventions - enveloppe, pagination, idempotence, codes d’erreur - si bien que le tableau vous indique où se trouve une ressource et comment l’appel est authentifié.

Les chemins sont des préfixes : /api/v1/contacts couvre GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id et ainsi de suite. Le préfixe le plus long l’emporte, c’est pourquoi une sous-famille publique comme /kb/public peut se trouver sous un /kb authentifié.

CatégorieQui peut appeler
userMembre du compte - JWT ou clé d'API, X-Account-Id obligatoire
loginAnonyme, limites de connexion strictes (10 par IP et par minute)
unauthenticatedAnonyme
widgetAnonyme, limité par clé de site et origine (60 par site et par IP et par minute)
webhook-inboundSigné par l'expéditeur - voir Webhooks
partnerJWT partenaire (portail partenaires)

Auth & account

PréfixeServiceCatégorie
/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

PréfixeServiceCatégorie
/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

PréfixeServiceCatégorie
/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

PréfixeServiceCatégorie
/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

PréfixeServiceCatégorie
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

PréfixeServiceCatégorie
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

PréfixeServiceCatégorie
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

PréfixeServiceCatégorie
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

PréfixeServiceCatégorie
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

PréfixeServiceCatégorie
/api/v1/automationautomation-serviceuser

Reports

PréfixeServiceCatégorie
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
PréfixeServiceCatégorie
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

PréfixeServiceCatégorie
/api/v1/aiplugin-serviceuser · délai de 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

PréfixeServiceCatégorie
/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

PréfixeServiceCatégorie
/api/v1/mediamedia-serviceuser

Billing

PréfixeServiceCatégorie
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

PréfixeServiceCatégorie
/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)

PréfixeServiceCatégorie
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Autres

PréfixeServiceCatégorie
/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

Ce tableau est généré à partir de la table de routage de la passerelle dans le dépôt backend, dont un instantané est intégré à ce site. Une vérification avant chaque déploiement compare l’instantané à la table de routage actuelle : une famille ne peut donc pas être ajoutée ou retirée dans le produit sans que cette page change. Les routes internes de la console du personnel sont exclues. Le document OpenAPI lisible par machine est décrit sur la page OpenAPI.