Exemples de requêtes et de réponses

GEThttps://jamdesk-docs.jamdesk.app/api/playground/demo/tickets/{ticket_id}

Utilisez RequestExample et ResponseExample pour afficher une utilisation réelle de l'API aux côtés de la documentation de vos endpoints. Les composants prennent en charge plusieurs langages, des statuts de réponse et des explications en ligne.

Exemple : Récupérer un ticket de support

Cet exemple documente un endpoint simple GET /tickets/{ticket_id} pour l'API de support Acme.

Requête

Utilisez des champs de paramètre pour décrire ce que l'endpoint attend. L'exemple de code se trouve dans la barre latérale droite.

ticket_idstringrequired

Identifiant unique du ticket renvoyé lors de la création du ticket.

curl -X GET https://api.acme.com/v1/tickets/tkt_9S8L2 \
  -H "Authorization: Bearer $ACME_TOKEN"

Réponse

Utilisez des champs de réponse pour documenter les attributs les plus importants renvoyés par l'API.

idstringrequired

Identifiant unique du ticket.

statusstring

Statut actuel du ticket (open, pending ou resolved).

created_atstring

Horodatage ISO 8601 indiquant la date de création du ticket.

{
  "id": "tkt_9S8L2",
  "customer_id": "cus_2X9W8",
  "subject": "Export stuck on step 3",
  "priority": "high",
  "status": "open",
  "created_at": "2026-02-04T16:12:00Z"
}

Conseils

Incluez au moins une réponse de succès et une réponse d'erreur.
Utilisez des identifiants et des horodatages réalistes pour que les exemples paraissent authentiques.
Gardez les charges utiles minimales afin que les lecteurs puissent les parcourir rapidement.

Pages associées

API Playground

Activez les tests API interactifs sur vos pages d'endpoints

Exemple OpenAPI

Voir une page d'endpoint générée automatiquement

Composant Examples

Découvrez les propriétés et les règles de formatage du composant

Composant Fields

Documentez les schémas de requêtes et de réponses