Endpunktgruppen

Die API wird von einem einzigen Gateway (api.rolchat.com) bereitgestellt, das jede Pfadgruppe an den zuständigen Dienst weiterleitet. Diese Seite listet jede Gruppe auf, die das Gateway für Kunden bereitstellt, geordnet nach Modul. Alle Gruppen teilen sich die Konventionen - Envelope, Paginierung, Idempotenz, Fehlercodes -, daher zeigt die Tabelle, wo eine Ressource liegt und wie der Aufruf authentifiziert wird.

Pfade sind Präfixe: /api/v1/contacts umfasst GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id und so weiter. Das längste Präfix gewinnt, weshalb eine öffentliche Untergruppe wie /kb/public unter einem authentifizierten /kb liegen kann.

Authentifizierungsklassen

Klasse	Wer aufrufen darf
user	Kontomitglied - JWT oder API-Schlüssel, X-Account-Id erforderlich
login	Anonym, strenge Anmeldelimits (10 pro IP und Minute)
unauthenticated	Anonym
widget	Anonym, begrenzt auf Website-Schlüssel und Origin (60 pro Website und IP und Minute)
webhook-inbound	Vom Absender signiert - siehe Webhooks
partner	Partner-JWT (Partnerportal)

Gruppen

Auth & account

Präfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

Präfix	Dienst	Klasse
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Marketing

Präfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

Präfix	Dienst	Klasse
/api/v1/automation	automation-service	user

Reports

Präfix	Dienst	Klasse
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privacy & consent

Präfix	Dienst	Klasse
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

Präfix	Dienst	Klasse
/api/v1/ai	plugin-service	user · 60 s Timeout
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Notifications

Präfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/api/v1/media	media-service	user

Billing

Präfix	Dienst	Klasse
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partner portal

Präfix	Dienst	Klasse
/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äfix	Dienst	Klasse
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

Sonstige

Präfix	Dienst	Klasse
/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

Woher die Liste stammt

Diese Tabelle wird aus der Routentabelle des Gateways im Backend-Repository generiert und als Snapshot in diese Website übernommen. Eine Prüfung vor jedem Deployment vergleicht den Snapshot mit der aktuellen Routentabelle, sodass im Produkt keine Gruppe hinzugefügt oder entfernt werden kann, ohne dass sich diese Seite ändert. Interne Routen der Personalkonsole sind ausgeschlossen. Das maschinenlesbare OpenAPI-Dokument wird auf der Seite OpenAPI beschrieben.