Rotas da API REST

A API REST está versionada em api.pl/v1 e utiliza tokens Bearer com âmbitos.

Rotas principais

  • GET /v1/ping – verificar a acessibilidade

  • GET /v1/openapi.json – obter a descrição OpenAPI

  • GET /v1/me – obter informações sobre o token utilizado

  • GET /v1/tickets – listar tickets

  • POST /v1/tickets – criar um ticket

  • GET /v1/tickets/{ticket_id} – ler um ticket

  • PATCH /v1/tickets/{ticket_id} – alterar propriedades do ticket

  • GET /v1/tickets/{ticket_id}/articles – listar artigos

  • POST /v1/tickets/{ticket_id}/articles – criar um artigo

  • GET /v1/attachments/{attachment_id} – transferir um anexo

  • GET /v1/master-data/{type} – ler filas, estados, prioridades, serviços, SLAs ou campos dinâmicos

  • GET /v1/customers e POST /v1/customers – ler ou criar clientes

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

  • GET /v1/customer-users e POST /v1/customer-users – ler ou criar utilizadores clientes

  • PATCH /v1/customer-users/{customer_user_id} – alterar utilizadores clientes

Âmbitos de autorização

A versão do código-fonte utiliza, entre outros, tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read e customers.write. Os módulos adicionais podem registar os seus próprios âmbitos e rotas no respetivo espaço de nomes.