REST-API-routes

De REST-API is geversioneerd onder api.pl/v1 en gebruikt Bearer-tokens met scopes.

Kernroutes

  • GET /v1/ping – bereikbaarheid controleren

  • GET /v1/openapi.json – OpenAPI-beschrijving ophalen

  • GET /v1/me – informatie over het gebruikte token ophalen

  • GET /v1/tickets – tickets weergeven

  • POST /v1/tickets – een ticket maken

  • GET /v1/tickets/{ticket_id} – een ticket lezen

  • PATCH /v1/tickets/{ticket_id} – ticketeigenschappen wijzigen

  • GET /v1/tickets/{ticket_id}/articles – artikelen weergeven

  • POST /v1/tickets/{ticket_id}/articles – een artikel maken

  • GET /v1/attachments/{attachment_id} – een bijlage downloaden

  • GET /v1/master-data/{type} – wachtrijen, statussen, prioriteiten, services, SLA’s of dynamische velden lezen

  • GET /v1/customers en POST /v1/customers – klanten lezen of maken

  • PATCH /v1/customers/{customer_id} – klanten wijzigen

  • GET /v1/customer-users en POST /v1/customer-users – klantgebruikers lezen of maken

  • PATCH /v1/customer-users/{customer_user_id} – klantgebruikers wijzigen

Autorisatiescopes

De bronversie gebruikt onder meer tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read en customers.write. Add-onmodules kunnen eigen scopes en routes in hun naamruimte registreren.