Familii de endpointuri
API-ul este servit de un singur gateway (api.rolchat.com) care direcționează fiecare familie de căi către serviciul care o deține. Această pagină listează fiecare familie pe care gateway-ul o expune clienților, grupată pe module. Toate familiile respectă aceleași convenții - structura răspunsului, paginare, idempotență, coduri de eroare - așa că tabelul îți spune unde se află o resursă și cum este autentificat apelul.
Căile sunt prefixe: /api/v1/contacts acoperă GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id și așa mai departe. Câștigă prefixul cel mai lung, motiv pentru care o subfamilie publică precum /kb/public se poate afla sub un /kb autentificat.
Categorii de autentificare
Secțiune intitulată „Categorii de autentificare”| Categorie | Cine poate apela |
|---|---|
user | Membru al contului - JWT sau cheie API, X-Account-Id obligatoriu |
login | Anonim, limite stricte de autentificare (10 pe minut per IP) |
unauthenticated | Anonim |
widget | Anonim, limitat după cheia site-ului și origine (60 pe minut per site și IP) |
webhook-inbound | Semnat de expeditor - vezi Webhook-uri |
partner | JWT de partener (portalul partenerilor) |
Auth & account
| Prefix | Serviciu | Categorie |
|---|---|---|
/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
| Prefix | Serviciu | Categorie |
|---|---|---|
/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
| Prefix | Serviciu | Categorie |
|---|---|---|
/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
| Prefix | Serviciu | Categorie |
|---|---|---|
/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
| Prefix | Serviciu | Categorie |
|---|---|---|
/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
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Prefix | Serviciu | Categorie |
|---|---|---|
/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
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/ai | plugin-service | user · timp limită 60 s |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| Prefix | Serviciu | Categorie |
|---|---|---|
/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
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| Prefix | Serviciu | Categorie |
|---|---|---|
/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)
| Prefix | Serviciu | Categorie |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Altele
| Prefix | Serviciu | Categorie |
|---|---|---|
/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 |
De unde provine lista
Secțiune intitulată „De unde provine lista”Acest tabel este generat din tabelul de rute al gateway-ului din depozitul backend, preluat ca instantaneu în acest site. O verificare înainte de fiecare lansare compară instantaneul cu tabelul de rute curent, așa că o familie nu poate fi adăugată sau eliminată din produs fără ca această pagină să se schimbe. Rutele interne ale consolei personalului sunt excluse. Documentul OpenAPI care poate fi citit automat este descris pe pagina OpenAPI.