Skip to main content

API Reference

Base URL: http://HOST:PORT/api/v1

Auth header: x-api-key: <accessToken> (para rutas con @Auth())

Docs interactivos: http://HOST:PORT/api/docs (Swagger, solo en non-production)


Auth

MétodoEndpointAuthBody
POST/auth/loginNo{ email, password }
POST/auth/frame-loginNo{ token, tenantId }
GET/auth/me

Users

MétodoEndpointAuth
GET/users
GET/users/:id
POST/users
PATCH/users/:id
DELETE/users/:id

Tenants

MétodoEndpointAuth
GET/tenants
GET/tenants/:id
POST/tenants
PATCH/tenants/:id
DELETE/tenants/:id
POST/tenants/:id/tokens

API Keys

MétodoEndpointAuth
GET/api-keys
GET/api-keys/:id
POST/api-keys
PATCH/api-keys/:id
DELETE/api-keys/:id

RBAC (Roles, Permisos, Módulos)

MétodoEndpointAuth
GET/POST/PATCH/DELETE/modules
GET/POST/PATCH/DELETE/roles
GET/POST/PATCH/DELETE/permissions
GET/POST/PATCH/DELETE/role-permissions

Contacts

MétodoEndpointAuth
GET/contacts
GET/contacts/:id
POST/contacts
PATCH/contacts/:id
DELETE/contacts/:id
POST/contacts/:id/labels

Labels

MétodoEndpointAuth
GET/labels
GET/labels/:id
POST/labels
PATCH/labels/:id
DELETE/labels/:id

Tickets

MétodoEndpointAuth
GET/tickets
GET/tickets/:id
PATCH/tickets/:id
DELETE/tickets/:id

Messages

MétodoEndpointAuth
GET/messages
GET/messages/:id
POST/messages
PATCH/messages/:id
DELETE/messages/:id

Files

MétodoEndpointAuthNotes
POST/files/uploadmultipart/form-data
GET/files/:idMetadatos
DELETE/files/:idElimina BD + storage

Quick Responses

MétodoEndpointAuth
GET/quick-responses
GET/quick-responses/:id
POST/quick-responses
PATCH/quick-responses/:id
DELETE/quick-responses/:id

Chat (WebSocket)

Conexión: ws://HOST:PORT/chat

Ver documentación completa del Chat.