Preskoči na vsebino

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«
SkupinaKdo sme klicati
userČlan računa - JWT ali ključ API, obvezen X-Account-Id
loginAnonimno, stroge omejitve prijave (10 na IP naslov na minuto)
unauthenticatedAnonimno
widgetAnonimno, omejeno s ključem spletnega mesta in izvorom (60 na spletno mesto in IP naslov na minuto)
webhook-inboundPodpiše pošiljatelj - glejte Webhooki
partnerJWT partnerja (partnerski portal)

Auth & account

PredponaStoritevSkupina
/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

PredponaStoritevSkupina
/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

PredponaStoritevSkupina
/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

PredponaStoritevSkupina
/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

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

Visitors

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

Knowledge base

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

Marketing

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

Phone

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

Automation

PredponaStoritevSkupina
/api/v1/automationautomation-serviceuser

Reports

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

AI

PredponaStoritevSkupina
/api/v1/aiplugin-serviceuser · časovna omejitev 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

PredponaStoritevSkupina
/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

PredponaStoritevSkupina
/api/v1/mediamedia-serviceuser

Billing

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

Partner portal

PredponaStoritevSkupina
/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)

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

Drugo

PredponaStoritevSkupina
/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

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.