Végpontcsaládok
Az API-t egyetlen átjáró (api.rolchat.com) szolgálja ki, amely minden útvonalcsaládot a hozzá tartozó szolgáltatáshoz irányít. Ez az oldal modulok szerint csoportosítva felsorolja az átjáró által az ügyfelek számára elérhetővé tett összes családot. Minden család ugyanazokat a konvenciókat követi - boríték, lapozás, idempotencia, hibakódok -, így a táblázat azt mutatja meg, hol található egy erőforrás, és hogyan hitelesítjük a hívást.
Az útvonalak előtagok: a /api/v1/contacts lefedi a GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id stb. hívásokat. A leghosszabb előtag nyer, ezért helyezkedhet el egy nyilvános alcsalád, például a /kb/public, egy hitelesített /kb alatt.
Hitelesítési kategóriák
Szekció neve “Hitelesítési kategóriák”| Kategória | Ki hívhatja |
|---|---|
user | Fióktag - JWT vagy API-kulcs, X-Account-Id kötelező |
login | Névtelen, szigorú bejelentkezési korlátokkal (IP-címenként percenként 10) |
unauthenticated | Névtelen |
widget | Névtelen, webhelykulcs és eredet szerint korlátozva (webhelyenként és IP-címenként percenként 60) |
webhook-inbound | A küldő által aláírva - lásd: Webhookok |
partner | Partner JWT (partnerportál) |
Családok
Szekció neve “Családok”Hitelesítés és fiók
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Beszélgetések és beérkezett üzenetek
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Jegyek
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Csatornák és widget
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Látogatók
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Tudásbázis
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Telefon
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automatizálás
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/automation | automation-service | user |
Jelentések
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Adatvédelem és hozzájárulás
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/ai | plugin-service | user · 60 s időkorlát |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Értesítések
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Média
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/media | media-service | user |
Számlázás
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partnerportál
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Személyazonosság-ellenőrzés (KYC)
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Egyéb
| Előtag | Szolgáltatás | Kategória |
|---|---|---|
/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 |
Honnan származik a lista
Szekció neve “Honnan származik a lista”Ez a táblázat a backend-tárolóban lévő átjáró útvonaltáblájából készül, amelynek pillanatképe ebbe a webhelybe kerül. Minden telepítés előtt egy ellenőrzés összeveti a pillanatképet az aktuális útvonaltáblával, így a termékben egyetlen család sem adható hozzá vagy távolítható el anélkül, hogy ez az oldal megváltozna. A belső munkatársi konzol útvonalai nem szerepelnek. A gép által olvasható OpenAPI-dokumentum leírása az OpenAPI oldalon található.