Route API REST

L’API REST è versionata in api.pl/v1 e utilizza token Bearer con scope.

Route principali

  • GET /v1/ping – verificare la raggiungibilità

  • GET /v1/openapi.json – recuperare la descrizione OpenAPI

  • GET /v1/me – recuperare informazioni sul token utilizzato

  • GET /v1/tickets – elencare i ticket

  • POST /v1/tickets – creare un ticket

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

  • PATCH /v1/tickets/{ticket_id} – modificare le proprietà del ticket

  • GET /v1/tickets/{ticket_id}/articles – elencare gli articoli

  • POST /v1/tickets/{ticket_id}/articles – creare un articolo

  • GET /v1/attachments/{attachment_id} – scaricare un allegato

  • GET /v1/master-data/{type} – leggere code, stati, priorità, servizi, SLA o campi dinamici

  • GET /v1/customers e POST /v1/customers – leggere o creare clienti

  • PATCH /v1/customers/{customer_id} – modificare clienti

  • GET /v1/customer-users e POST /v1/customer-users – leggere o creare utenti cliente

  • PATCH /v1/customer-users/{customer_user_id} – modificare utenti cliente

Ambiti di autorizzazione

La versione sorgente utilizza, tra gli altri, tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read e customers.write. I moduli aggiuntivi possono registrare scope e route propri nel relativo namespace.