Obitelji krajnjih točaka
API poslužuje jedan pristupnik (api.rolchat.com) koji svaku obitelj putanja usmjerava usluzi kojoj pripada. Ova stranica navodi svaku obitelj koju pristupnik izlaže korisnicima, grupiranu po modulima. Sve obitelji dijele iste konvencije - omotnicu odgovora, straničenje, idempotentnost, kodove grešaka - pa tablica govori gdje se resurs nalazi i kako se poziv autentificira.
Putanje su prefiksi: /api/v1/contacts obuhvaća GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id i tako dalje. Prednost ima najdulji prefiks, zato javna podobitelj poput /kb/public može biti ispod autentificiranog /kb.
Skupine autentifikacije
Odjeljak „Skupine autentifikacije”| Skupina | Tko smije pozivati |
|---|---|
user | Član računa - JWT ili API ključ, obavezan X-Account-Id |
login | Anonimno, stroga ograničenja prijave (10 po IP adresi u minuti) |
unauthenticated | Anonimno |
widget | Anonimno, ograničeno ključem stranice i izvorom (60 po stranici i IP adresi u minuti) |
webhook-inbound | Potpisuje pošiljatelj - vidi Webhookovi |
partner | JWT partnera (partnerski portal) |
Obitelji
Odjeljak „Obitelji”Auth & account
| Prefiks | Usluga | 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
| Prefiks | Usluga | 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
| Prefiks | Usluga | 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
| Prefiks | Usluga | 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
| Prefiks | Usluga | 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
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Prefiks | Usluga | 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
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/ai | plugin-service | user · vremensko ograničenje 60 s |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| Prefiks | Usluga | 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
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| Prefiks | Usluga | Skupina |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| Prefiks | Usluga | 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)
| Prefiks | Usluga | 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 |
Ostalo
| Prefiks | Usluga | 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 |
Odakle dolazi popis
Odjeljak „Odakle dolazi popis”Ova se tablica generira iz tablice ruta pristupnika u repozitoriju pozadinskog sustava, čija je snimka pohranjena na ovoj stranici. Provjera prije svake objave uspoređuje snimku s trenutačnom tablicom ruta, pa se u proizvodu ne može dodati ni ukloniti obitelj a da se ova stranica ne promijeni. Interne rute konzole za osoblje su izostavljene. Strojno čitljiv OpenAPI dokument opisan je na stranici OpenAPI.