Ejemplos de solicitud y respuesta

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

Usa RequestExample y ResponseExample para mostrar el uso real de la API junto a la documentación de tu endpoint. Los componentes admiten múltiples lenguajes, estados de respuesta y explicaciones en línea.

Ejemplo: Obtener un ticket de soporte

Este ejemplo documenta un endpoint simple GET /tickets/{ticket_id} para la API de soporte de Acme.

Solicitud

Usa campos de parámetros para describir qué espera el endpoint. El ejemplo de código se encuentra en la barra lateral derecha.

ticket_idstringrequired

Identificador único del ticket devuelto cuando se creó el ticket.

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

Respuesta

Usa campos de respuesta para documentar los atributos más importantes devueltos por la API.

idstringrequired

Identificador único del ticket.

statusstring

Estado actual del ticket (open, pending o resolved).

created_atstring

Marca de tiempo ISO 8601 de cuándo se creó el 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"
}

Consejos

Incluye al menos una respuesta de éxito y una respuesta de error.
Usa identificadores y marcas de tiempo realistas para que los ejemplos parezcan reales.
Mantén los payloads mínimos para que los lectores puedan escanearlos rápidamente.

Páginas relacionadas

API Playground

Habilita pruebas interactivas de API en tus páginas de endpoint

Ejemplo OpenAPI

Ver una página de endpoint generada automáticamente

Componente Examples

Aprende las props del componente y las reglas de formato

Componente Fields

Documenta esquemas de solicitud y respuesta