REST-API-Routen

Die REST-API ist unter api.pl/v1 versioniert und verwendet Bearer-Token mit Scopes.

Kernrouten

  • GET /v1/ping – Erreichbarkeit prüfen

  • GET /v1/openapi.json – OpenAPI-Beschreibung abrufen

  • GET /v1/me – Informationen zum verwendeten Token abrufen

  • GET /v1/tickets – Tickets auflisten

  • POST /v1/tickets – Ticket erstellen

  • GET /v1/tickets/{ticket_id} – Ticket lesen

  • PATCH /v1/tickets/{ticket_id} – Ticketeigenschaften ändern

  • GET /v1/tickets/{ticket_id}/articles – Artikel auflisten

  • POST /v1/tickets/{ticket_id}/articles – Artikel erstellen

  • GET /v1/attachments/{attachment_id} – Anhang herunterladen

  • GET /v1/master-data/{type} – Queues, Status, Prioritäten, Services, SLAs oder dynamische Felder lesen

  • GET /v1/customers und POST /v1/customers – Kunden lesen oder anlegen

  • PATCH /v1/customers/{customer_id} – Kunden ändern

  • GET /v1/customer-users und POST /v1/customer-users – Kundenbenutzer lesen oder anlegen

  • PATCH /v1/customer-users/{customer_user_id} – Kundenbenutzer ändern

Berechtigungsbereiche

Der Quellstand verwendet unter anderem tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read und customers.write. Zusatzmodule können eigene Scopes und Routen in ihrem Namensraum registrieren.