Trasy REST API

REST API je verzováno pod api.pl/v1 a používá tokeny Bearer s rozsahy oprávnění.

Základní trasy

  • GET /v1/ping – ověřit dostupnost

  • GET /v1/openapi.json – načíst popis OpenAPI

  • GET /v1/me – načíst informace o použitém tokenu

  • GET /v1/tickets – vypsat tickety

  • POST /v1/tickets – vytvořit ticket

  • GET /v1/tickets/{ticket_id} – načíst ticket

  • PATCH /v1/tickets/{ticket_id} – změnit vlastnosti ticketu

  • GET /v1/tickets/{ticket_id}/articles – vypsat články

  • POST /v1/tickets/{ticket_id}/articles – vytvořit článek

  • GET /v1/attachments/{attachment_id} – stáhnout přílohu

  • GET /v1/master-data/{type} – načíst fronty, stavy, priority, služby, SLA nebo dynamická pole

  • GET /v1/customers a POST /v1/customers – načíst nebo vytvořit zákazníky

  • PATCH /v1/customers/{customer_id} – změnit zákazníky

  • GET /v1/customer-users a POST /v1/customer-users – načíst nebo vytvořit zákaznické uživatele

  • PATCH /v1/customer-users/{customer_user_id} – změnit zákaznické uživatele

Rozsahy oprávnění

Zdrojová verze používá mimo jiné tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read a customers.write. Doplňkové moduly mohou registrovat vlastní rozsahy a trasy ve svém jmenném prostoru.