Exemplos de requisição e resposta

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

Use RequestExample e ResponseExample para mostrar o uso real da API junto à documentação dos endpoints. Os componentes aceitam várias linguagens, status de resposta e explicações incorporadas.

Exemplo: recuperar um ticket de suporte

Este exemplo documenta um endpoint simples GET /tickets/{ticket_id} da API de suporte da Acme.

Requisição

Use campos de parâmetros para descrever o que o endpoint espera. O exemplo de código aparece na barra lateral direita.

ticket_idstringrequired

Identificador exclusivo do ticket, retornado quando o ticket foi criado.

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

Resposta

Use campos de resposta para documentar os atributos mais importantes retornados pela API.

idstringrequired

Identificador exclusivo do ticket.

statusstring

Status atual do ticket (open, pending ou resolved).

created_atstring

Carimbo de data e hora ISO 8601 de criação do 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"
}

Dicas

Inclua pelo menos uma resposta de sucesso e uma resposta de erro.
Use identificadores e carimbos de data e hora realistas para tornar os exemplos mais convincentes.
Mantenha os payloads mínimos para que os leitores possam analisá-los rapidamente.

Páginas relacionadas

Playground de API

Ative testes interativos da API nas páginas dos seus endpoints

Exemplo de OpenAPI

Veja uma página de endpoint gerada automaticamente

Componente Examples

Aprenda os props do componente e as regras de formatação

Componente Fields

Documente esquemas de requisição e resposta