Družine končnih točk
API streže en prehod (api.rolchat.com), ki vsako družino poti usmeri k storitvi, ki ji pripada. Ta stran navaja vsako družino, ki jo prehod izpostavlja strankam, razvrščeno po modulih. Vse družine si delijo iste konvencije - ovojnico odgovora, ostranjevanje, idempotentnost, kode napak - zato tabela pove, kje je vir in kako se preveri pristnost klica.
Poti so predpone: /api/v1/contacts zajema GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id in tako naprej. Prednost ima najdaljša predpona, zato je javna poddružina, kot je /kb/public, lahko pod /kb s preverjeno pristnostjo.
Skupine preverjanja pristnosti
Razdelek »Skupine preverjanja pristnosti«| Skupina | Kdo sme klicati |
|---|---|
user | Član računa - JWT ali ključ API, obvezen X-Account-Id |
login | Anonimno, stroge omejitve prijave (10 na IP naslov na minuto) |
unauthenticated | Anonimno |
widget | Anonimno, omejeno s ključem spletnega mesta in izvorom (60 na spletno mesto in IP naslov na minuto) |
webhook-inbound | Podpiše pošiljatelj - glejte Webhooki |
partner | JWT partnerja (partnerski portal) |
Družine
Razdelek »Družine«Auth & account
| Predpona | Storitev | Skupina |
|---|---|---|
/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
| Predpona | Storitev | Skupina |
|---|---|---|
/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
| Predpona | Storitev | Skupina |
|---|---|---|
/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
| Predpona | Storitev | Skupina |
|---|---|---|
/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
| Predpona | Storitev | Skupina |
|---|---|---|
/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
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Predpona | Storitev | Skupina |
|---|---|---|
/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
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/ai | plugin-service | user · časovna omejitev 60 s |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| Predpona | Storitev | Skupina |
|---|---|---|
/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
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| Predpona | Storitev | Skupina |
|---|---|---|
/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)
| Predpona | Storitev | Skupina |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Drugo
| Predpona | Storitev | Skupina |
|---|---|---|
/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 |
Od kod izvira seznam
Razdelek »Od kod izvira seznam«Ta tabela je ustvarjena iz tabele poti prehoda v repozitoriju zaledja, katere posnetek je shranjen na tem spletnem mestu. Preverjanje pred vsako namestitvijo primerja posnetek s trenutno tabelo poti, zato v izdelku ni mogoče dodati ali odstraniti družine, ne da bi se spremenila ta stran. Notranje poti konzole za osebje so izključene. Strojno berljiv dokument OpenAPI je opisan na strani OpenAPI.