Routes de l’API REST

L’API REST est versionnée sous api.pl/v1 et utilise des jetons Bearer avec des portées.

Routes principales

  • GET /v1/ping – vérifier l’accessibilité

  • GET /v1/openapi.json – récupérer la description OpenAPI

  • GET /v1/me – récupérer les informations sur le jeton utilisé

  • GET /v1/tickets – lister les tickets

  • POST /v1/tickets – créer un ticket

  • GET /v1/tickets/{ticket_id} – lire un ticket

  • PATCH /v1/tickets/{ticket_id} – modifier les propriétés du ticket

  • GET /v1/tickets/{ticket_id}/articles – lister les articles

  • POST /v1/tickets/{ticket_id}/articles – créer un article

  • GET /v1/attachments/{attachment_id} – télécharger une pièce jointe

  • GET /v1/master-data/{type} – lire les files, états, priorités, services, SLA ou champs dynamiques

  • GET /v1/customers et POST /v1/customers – lire ou créer des clients

  • PATCH /v1/customers/{customer_id} – modifier des clients

  • GET /v1/customer-users et POST /v1/customer-users – lire ou créer des utilisateurs clients

  • PATCH /v1/customer-users/{customer_user_id} – modifier des utilisateurs clients

Portées d’autorisation

La version source utilise notamment tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read et customers.write. Les modules complémentaires peuvent enregistrer leurs propres portées et routes dans leur espace de noms.