Päätepisteperheet
API:a tarjoaa yksi yhdyskäytävä (api.rolchat.com), joka ohjaa kunkin polkuperheen sen omistavalle palvelulle. Tämä sivu luettelee jokaisen perheen, jonka yhdyskäytävä tarjoaa asiakkaille, moduuleittain ryhmiteltynä. Kaikki perheet noudattavat samoja käytäntöjä - kirjekuori, sivutus, idempotenssi, virhekoodit - joten taulukko kertoo, missä resurssi sijaitsee ja miten kutsu todennetaan.
Polut ovat etuliitteitä: /api/v1/contacts kattaa GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id ja niin edelleen. Pisin etuliite voittaa, minkä vuoksi julkinen alaperhe, kuten /kb/public, voi olla todennetun /kb-perheen alla.
Todennusluokat
Osio nimeltä “Todennusluokat”| Luokka | Kuka saa kutsua |
|---|---|
user | Tilin jäsen - JWT tai API-avain, X-Account-Id pakollinen |
login | Anonyymi, tiukat kirjautumisrajat (10 IP-osoitetta kohden minuutissa) |
unauthenticated | Anonyymi |
widget | Anonyymi, rajattu sivustoavaimen ja alkuperän mukaan (60 sivustoa ja IP-osoitetta kohden minuutissa) |
webhook-inbound | Lähettäjän allekirjoittama - katso Webhookit |
partner | Kumppanin JWT (kumppaniportaali) |
Perheet
Osio nimeltä “Perheet”Todennus ja tili
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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 |
Keskustelut ja postilaatikko
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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 |
Tiketit
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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 |
Kanavat ja widget
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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 |
Vierailijat
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Tietopankki
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Markkinointi
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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 |
Puhelin
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automaatio
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/automation | automation-service | user |
Raportit
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Tietosuoja ja suostumus
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/ai | plugin-service | user · 60 s:n aikakatkaisu |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Ilmoitukset
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/media | media-service | user |
Laskutus
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Kumppaniportaali
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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 |
Henkilöllisyyden todentaminen (KYC)
| Etuliite | Palvelu | Luokka |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Muut
| Etuliite | Palvelu | Luokka |
|---|---|---|
/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 |
Mistä luettelo tulee
Osio nimeltä “Mistä luettelo tulee”Tämä taulukko luodaan taustajärjestelmän repositorion yhdyskäytävän reittitaulukosta, josta on otettu tilannekuva tälle sivustolle. Ennen jokaista julkaisua tehtävä tarkistus vertaa tilannekuvaa nykyiseen reittitaulukkoon, joten perhettä ei voi lisätä tuotteeseen tai poistaa siitä ilman, että tämä sivu muuttuu. Henkilökunnan sisäisen konsolin reitit on jätetty pois. Koneluettava OpenAPI-dokumentti kuvataan sivulla OpenAPI.