Eindpuntfamilies
Die API word deur een poort (api.rolchat.com) bedien wat elke padfamilie na die diens roeteer wat dit besit. Hierdie bladsy lys elke familie wat die poort aan kliënte beskikbaar stel, gegroepeer volgens module. Alle families deel die konvensies - omslag, paginering, idempotensie, foutkodes - so die tabel vertel jou waar ’n hulpbron woon en hoe die oproep geverifieer word.
Paaie is voorvoegsels: /api/v1/contacts dek GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id ensovoorts. Die langste voorvoegsel wen, en daarom kan ’n publieke subfamilie soos /kb/public onder ’n geverifieerde /kb sit.
Verifikasiekategorieë
Afdeling getiteld “Verifikasiekategorieë”| Kategorie | Wie mag roep |
|---|---|
user | Rekeninglid - JWT of API-sleutel, X-Account-Id vereis |
login | Anoniem, streng aanmeldlimiete (10 per IP per minuut) |
unauthenticated | Anoniem |
widget | Anoniem, afgebaken volgens webwerfsleutel en oorsprong (60 per webwerf en IP per minuut) |
webhook-inbound | Deur die sender onderteken - sien Webhooks |
partner | Vennoot-JWT (vennootportaal) |
Families
Afdeling getiteld “Families”Auth & account
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/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
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/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 | Diens | Kategorie |
|---|---|---|
/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 | Diens | Kategorie |
|---|---|---|
/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
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/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
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/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
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/ai | plugin-service | user · uittelling van 60 s |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/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 | Diens | Kategorie |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/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)
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Ander
| Voorvoegsel | Diens | Kategorie |
|---|---|---|
/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 die lys vandaan kom
Afdeling getiteld “Waar die lys vandaan kom”Hierdie tabel word gegenereer uit die poort se roetetabel in die agterkant-bewaarplek en as ’n momentopname in hierdie webwerf opgeneem. ’n Kontrole voor elke ontplooiing vergelyk die momentopname met die huidige roetetabel, sodat ’n familie nie in die produk bygevoeg of verwyder kan word sonder dat hierdie bladsy verander nie. Interne roetes van die personeelkonsole is uitgesluit. Die masjienleesbare OpenAPI-dokument word op die OpenAPI-bladsy beskryf.