Trasy REST API

Interfejs REST API jest wersjonowany pod api.pl/v1 i używa tokenów Bearer z zakresami uprawnień.

Trasy podstawowe

  • GET /v1/ping – sprawdzić dostępność

  • GET /v1/openapi.json – pobrać opis OpenAPI

  • GET /v1/me – pobrać informacje o używanym tokenie

  • GET /v1/tickets – wyświetlić listę zgłoszeń

  • POST /v1/tickets – utworzyć zgłoszenie

  • GET /v1/tickets/{ticket_id} – odczytać zgłoszenie

  • PATCH /v1/tickets/{ticket_id} – zmienić właściwości zgłoszenia

  • GET /v1/tickets/{ticket_id}/articles – wyświetlić listę artykułów

  • POST /v1/tickets/{ticket_id}/articles – utworzyć artykuł

  • GET /v1/attachments/{attachment_id} – pobrać załącznik

  • GET /v1/master-data/{type} – odczytać kolejki, stany, priorytety, usługi, SLA lub pola dynamiczne

  • GET /v1/customers i POST /v1/customers – odczytać lub utworzyć klientów

  • PATCH /v1/customers/{customer_id} – zmienić klientów

  • GET /v1/customer-users i POST /v1/customer-users – odczytać lub utworzyć użytkowników klientów

  • PATCH /v1/customer-users/{customer_user_id} – zmienić użytkowników klientów

Zakresy uprawnień

Wersja źródłowa używa między innymi tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read i customers.write. Moduły dodatkowe mogą rejestrować własne zakresy i trasy w swojej przestrzeni nazw.