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égories d’authentification
Section intitulée « Catégories d’authentification »| Catégorie | Qui peut appeler |
|---|---|
user | Membre du compte - JWT ou clé d'API, X-Account-Id obligatoire |
login | Anonyme, limites de connexion strictes (10 par IP et par minute) |
unauthenticated | Anonyme |
widget | Anonyme, limité par clé de site et origine (60 par site et par IP et par minute) |
webhook-inbound | Signé par l'expéditeur - voir Webhooks |
partner | JWT partenaire (portail partenaires) |
Familles
Section intitulée « Familles »Auth & account
| Préfixe | Service | Catégorie |
|---|---|---|
/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
| Préfixe | Service | Catégorie |
|---|---|---|
/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
| Préfixe | Service | Catégorie |
|---|---|---|
/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
| Préfixe | Service | Catégorie |
|---|---|---|
/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
| Préfixe | Service | Catégorie |
|---|---|---|
/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
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Préfixe | Service | Catégorie |
|---|---|---|
/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
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/ai | plugin-service | user · délai de 60 s |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| Préfixe | Service | Catégorie |
|---|---|---|
/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
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| Préfixe | Service | Catégorie |
|---|---|---|
/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)
| Préfixe | Service | Catégorie |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Autres
| Préfixe | Service | Catégorie |
|---|---|---|
/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 |
Origine de la liste
Section intitulée « Origine de la liste »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.