REST API rotaları

REST API, api.pl/v1 altında sürümlenir ve kapsamlı Bearer tokenları kullanır.

Temel rotalar

  • GET /v1/ping – erişilebilirliği kontrol etmek

  • GET /v1/openapi.json – OpenAPI açıklamasını almak

  • GET /v1/me – kullanılan token hakkında bilgi almak

  • GET /v1/tickets – ticketleri listelemek

  • POST /v1/tickets – ticket oluşturmak

  • GET /v1/tickets/{ticket_id} – ticketi okumak

  • PATCH /v1/tickets/{ticket_id} – ticket özelliklerini değiştirmek

  • GET /v1/tickets/{ticket_id}/articles – makaleleri listelemek

  • POST /v1/tickets/{ticket_id}/articles – makale oluşturmak

  • GET /v1/attachments/{attachment_id} – eki indirmek

  • GET /v1/master-data/{type} – kuyrukları, durumları, öncelikleri, hizmetleri, SLA’ları veya dinamik alanları okumak

  • GET /v1/customers ve POST /v1/customers – müşterileri okumak veya oluşturmak

  • PATCH /v1/customers/{customer_id} – müşterileri değiştirmek

  • GET /v1/customer-users ve POST /v1/customer-users – müşteri kullanıcılarını okumak veya oluşturmak

  • PATCH /v1/customer-users/{customer_user_id} – müşteri kullanıcılarını değiştirmek

Yetkilendirme kapsamları

Kaynak sürüm diğerlerinin yanı sıra tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read ve customers.write kapsamlarını kullanır. Ek modüller kendi ad alanlarında özel kapsamlar ve rotalar kaydedebilir.