Rutas de la API REST

La API REST está versionada en api.pl/v1 y utiliza tokens Bearer con ámbitos.

Rutas principales

  • GET /v1/ping – comprobar la disponibilidad

  • GET /v1/openapi.json – obtener la descripción OpenAPI

  • GET /v1/me – obtener información sobre el token utilizado

  • GET /v1/tickets – listar tickets

  • POST /v1/tickets – crear un ticket

  • GET /v1/tickets/{ticket_id} – leer un ticket

  • PATCH /v1/tickets/{ticket_id} – cambiar propiedades del ticket

  • GET /v1/tickets/{ticket_id}/articles – listar artículos

  • POST /v1/tickets/{ticket_id}/articles – crear un artículo

  • GET /v1/attachments/{attachment_id} – descargar un archivo adjunto

  • GET /v1/master-data/{type} – leer colas, estados, prioridades, servicios, SLA o campos dinámicos

  • GET /v1/customers y POST /v1/customers – leer o crear clientes

  • PATCH /v1/customers/{customer_id} – modificar clientes

  • GET /v1/customer-users y POST /v1/customer-users – leer o crear usuarios de clientes

  • PATCH /v1/customer-users/{customer_user_id} – modificar usuarios de clientes

Ámbitos de autorización

La versión del código fuente utiliza, entre otros, tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read y customers.write. Los módulos adicionales pueden registrar sus propios ámbitos y rutas en su espacio de nombres.