Esempi di richiesta e risposta

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

Usa RequestExample e ResponseExample per mostrare un utilizzo reale delle API insieme alla documentazione degli endpoint. I componenti possono mostrare più linguaggi, stati di risposta e spiegazioni in linea.

Esempio: recuperare un ticket di supporto

Questo esempio documenta l'endpoint GET /tickets/{ticket_id} dell'API di supporto Acme.

Richiesta

Usa i campi dei parametri per descrivere ciò che l'endpoint si aspetta. L'esempio di codice si trova nella barra laterale destra.

ticket_idstringrequired

Identificatore univoco del ticket restituito al momento della sua creazione.

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

Risposta

Usa i campi della risposta per documentare gli attributi più importanti restituiti dall'API.

idstringrequired

Identificatore univoco del ticket.

statusstring

Stato attuale del ticket (open, pending oppure resolved).

created_atstring

Timestamp ISO 8601 che indica quando è stato creato il 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"
}

Suggerimenti

Includi almeno una risposta di successo e una risposta di errore.
Usa identificatori e timestamp realistici per rendere gli esempi credibili.
Mantieni i payload essenziali così che i lettori possano scorrerli rapidamente.

Pagine correlate

API Playground

Abilita il test interattivo delle API nelle pagine degli endpoint

OpenAPI Example

Vedi una pagina endpoint generata automaticamente

Examples Component

Props del componente e regole di formattazione

Fields Component

Documenta gli schemi di richiesta e risposta