Οικογένειες endpoints
Το API εξυπηρετείται από μία πύλη (api.rolchat.com) που δρομολογεί κάθε οικογένεια διαδρομών στην υπηρεσία που της ανήκει. Αυτή η σελίδα απαριθμεί κάθε οικογένεια που εκθέτει η πύλη στους πελάτες, ομαδοποιημένη ανά ενότητα. Όλες οι οικογένειες μοιράζονται τις συμβάσεις - φάκελο, σελιδοποίηση, idempotency, κωδικούς σφαλμάτων - οπότε ο πίνακας σας λέει πού βρίσκεται ένας πόρος και πώς γίνεται ο έλεγχος ταυτότητας της κλήσης.
Οι διαδρομές είναι προθέματα: το /api/v1/contacts καλύπτει τα GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id κ.ο.κ. Επικρατεί το μακρύτερο πρόθεμα, γι’ αυτό μια δημόσια υπο-οικογένεια όπως το /kb/public μπορεί να βρίσκεται κάτω από ένα /kb με έλεγχο ταυτότητας.
Κατηγορίες ελέγχου ταυτότητας
Ενότητα με τίτλο «Κατηγορίες ελέγχου ταυτότητας»| Κατηγορία | Ποιος μπορεί να καλεί |
|---|---|
user | Account member - JWT or API key, X-Account-Id required |
login | Anonymous, strict sign-in limits (10 per IP per minute) |
unauthenticated | Anonymous |
widget | Anonymous, scoped by site key and origin (60 per site and IP per minute) |
webhook-inbound | Signed by the sender - see Webhooks |
partner | Partner JWT (partner portal) |
Οικογένειες
Ενότητα με τίτλο «Οικογένειες»Auth & account
| Prefix | Service | Bucket |
|---|---|---|
/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
| Prefix | Service | Bucket |
|---|---|---|
/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
| Prefix | Service | Bucket |
|---|---|---|
/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
| Prefix | Service | Bucket |
|---|---|---|
/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
| Prefix | Service | Bucket |
|---|---|---|
/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
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| Prefix | Service | Bucket |
|---|---|---|
/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
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/ai | plugin-service | user · 60 s timeout |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| Prefix | Service | Bucket |
|---|---|---|
/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
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| Prefix | Service | Bucket |
|---|---|---|
/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)
| Prefix | Service | Bucket |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
Other
| Prefix | Service | Bucket |
|---|---|---|
/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 |
Από πού προέρχεται η λίστα
Ενότητα με τίτλο «Από πού προέρχεται η λίστα»Αυτός ο πίνακας παράγεται από τον πίνακα διαδρομών της πύλης στο αποθετήριο του backend, με στιγμιότυπο αποθηκευμένο σε αυτόν τον ιστότοπο. Ένας έλεγχος πριν από κάθε ανάπτυξη συγκρίνει το στιγμιότυπο με τον τρέχοντα πίνακα διαδρομών, οπότε μια οικογένεια δεν μπορεί να προστεθεί ή να αφαιρεθεί στο προϊόν χωρίς να αλλάξει αυτή η σελίδα. Οι εσωτερικές διαδρομές της κονσόλας προσωπικού εξαιρούνται. Το αναγνώσιμο από μηχανή έγγραφο OpenAPI περιγράφεται στη σελίδα OpenAPI.