Skip to main content

Modelo de página para api

📘 [NOME DO ENDPOINT]

Breve descrição do que esse endpoint faz.
Exemplo: "Criação de pedidos no sistema."


🔗 Endpoint

[VERBO HTTP] /api/v1/[recurso]

📥 Requisição

Headers obrigatórios:

Authorization: Token {seu_token}
Content-Type: application/json

Corpo da requisição (exemplo)

{
  "campo1": "valor",
  "campo2": "valor"
}

✅ Resposta de Sucesso

{
  "status": "ok",
  "dados": { }
}

❌ Respostas de Erro

  • 400 Bad Request → Requisição inválida.
  • 401 Unauthorized → Token inválido ou ausente.
  • 404 Not Found → Recurso não encontrado.
  • 500 Internal Server Error → Erro interno da API.

📌 Observações

  • Campos obrigatórios: campo1, campo2.
  • Respostas seguem o padrão JSON.
  • Tokens expiram em X horas.