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.
Authenticatiegroepen
Section titled “Authenticatiegroepen”| Groep | Wie mag aanroepen |
|---|---|
user | Accountlid - JWT of API-sleutel, X-Account-Id verplicht |
login | Anoniem, strenge inloglimieten (10 per IP-adres per minuut) |
unauthenticated | Anoniem |
widget | Anoniem, afgebakend op sitesleutel en origin (60 per site en IP-adres per minuut) |
webhook-inbound | Ondertekend door de afzender - zie Webhooks |
partner | Partner-JWT (partnerportaal) |
Families
Section titled “Families”Authenticatie en account
| Voorvoegsel | Service | Groep |
|---|---|---|
/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 |
Gesprekken en postvak IN
| Voorvoegsel | Service | Groep |
|---|---|---|
/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
| Voorvoegsel | Service | Groep |
|---|---|---|
/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
| Voorvoegsel | Service | Groep |
|---|---|---|
/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 |
Kanalen en widget
| Voorvoegsel | Service | Groep |
|---|---|---|
/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 |
Bezoekers
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Kennisbank
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Voorvoegsel | Service | Groep |
|---|---|---|
/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 |
Telefoon
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automatisering
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/automation | automation-service | user |
Rapporten
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy en toestemming
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/ai | plugin-service | user · time-out 60 s |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Meldingen
| Voorvoegsel | Service | Groep |
|---|---|---|
/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
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/media | media-service | user |
Facturatie
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partnerportaal
| Voorvoegsel | Service | Groep |
|---|---|---|
/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 |
Identiteitsverificatie (KYC)
| Voorvoegsel | Service | Groep |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Overig
| Voorvoegsel | Service | Groep |
|---|---|---|
/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 |
Waar de lijst vandaan komt
Section titled “Waar de lijst vandaan komt”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.