Preskoči na sadržaj

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.

SkupinaTko smije pozivati
userČlan računa - JWT ili API ključ, obavezan X-Account-Id
loginAnonimno, stroga ograničenja prijave (10 po IP adresi u minuti)
unauthenticatedAnonimno
widgetAnonimno, ograničeno ključem stranice i izvorom (60 po stranici i IP adresi u minuti)
webhook-inboundPotpisuje pošiljatelj - vidi Webhookovi
partnerJWT partnera (partnerski portal)

Auth & account

PrefiksUslugaSkupina
/api/v1/authiam-servicelogin
/api/v1/captchaiam-serviceunauthenticated
/api/v1/meiam-serviceuser
/api/v1/accountsiam-serviceuser
/api/v1/account-settingsiam-serviceuser
/api/v1/usersiam-serviceuser
/api/v1/membersiam-serviceuser
/api/v1/rolesiam-serviceuser
/api/v1/tokensiam-serviceuser
/api/v1/staff-access-policyiam-serviceuser
/api/v1/staff-access-sessionsiam-serviceuser
/api/v1/presenceiam-serviceuser
/api/v1/workforceiam-serviceuser
/api/v1/sitessites-serviceuser
/api/v1/profileprofile-serviceuser
/api/v1/teamsteams-serviceuser
/api/v1/auditaudit-serviceuser

Conversations & inbox

PrefiksUslugaSkupina
/api/v1/conversationsconversation-serviceuser
/api/v1/messagesconversation-serviceuser
/api/v1/conversation-tagsconversation-serviceuser
/api/v1/inboxesconversation-serviceuser
/api/v1/viewsconversation-serviceuser
/api/v1/templatesconversation-serviceuser
/api/v1/chat-routing-rulesconversation-serviceuser
/api/v1/macrosconversation-serviceuser
/api/v1/chat-settingsconversation-serviceuser
/api/v1/tasksconversation-serviceuser

CRM

PrefiksUslugaSkupina
/api/v1/leadscrm-serviceuser
/api/v1/contactscrm-serviceuser
/api/v1/companiescrm-serviceuser
/api/v1/dealscrm-serviceuser
/api/v1/pipelinescrm-serviceuser
/api/v1/lead-statusescrm-serviceuser
/api/v1/contact-tagscrm-serviceuser
/api/v1/segmentscrm-serviceuser
/api/v1/lead-routing-rulescrm-serviceuser
/api/v1/crm-settingscrm-serviceuser
/api/v1/crm/campaignscrm-serviceuser
/api/v1/custom-fieldsmeta-serviceuser

Tickets

PrefiksUslugaSkupina
/api/v1/ticketsticket-serviceuser
/api/v1/ticket-queuesticket-serviceuser
/api/v1/ticket-settingsticket-serviceuser
/api/v1/ticket-sla-policiesticket-serviceuser
/api/v1/ticket-custom-fieldsticket-serviceuser
/api/v1/ticket-tagsticket-serviceuser

Channels & widget

PrefiksUslugaSkupina
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

PrefiksUslugaSkupina
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

PrefiksUslugaSkupina
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

PrefiksUslugaSkupina
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

PrefiksUslugaSkupina
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

PrefiksUslugaSkupina
/api/v1/automationautomation-serviceuser

Reports

PrefiksUslugaSkupina
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
PrefiksUslugaSkupina
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

PrefiksUslugaSkupina
/api/v1/aiplugin-serviceuser · vremensko ograničenje 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

PrefiksUslugaSkupina
/api/v1/notifications-policynotification-serviceuser
/api/v1/notificationsnotification-serviceuser
/api/v1/notification-templatesnotification-serviceuser
/api/v1/notification-delivery-logsnotification-serviceuser
/api/v1/pushnotification-serviceuser

Media

PrefiksUslugaSkupina
/api/v1/mediamedia-serviceuser

Billing

PrefiksUslugaSkupina
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

PrefiksUslugaSkupina
/api/v1/partnerpartner-portal-servicepartner
/api/v1/partner/authiam-servicelogin
/api/v1/partner/invitationspartner-portal-servicelogin
/api/v1/partner/auth/mfa/enrolliam-servicepartner
/api/v1/partner/auth/mfa/confirmiam-servicepartner
/api/v1/partner/auth/step-upiam-servicepartner
/api/v1/rpartner-portal-servicewidget

Identity verification (KYC)

PrefiksUslugaSkupina
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Ostalo

PrefiksUslugaSkupina
/api/v1/auth/meiam-serviceuser
/api/v1/auth/sessionsiam-serviceuser
/api/v1/auth/mfaiam-serviceuser
/api/v1/auth/email-changeiam-serviceuser
/api/v1/auth/swap-companyiam-serviceuser
/api/v1/privacy/policiesprivacy-serviceuser
/api/v1/complianceprivacy-serviceuser
/api/v1/identity-graphidentity-graph-serviceuser

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.