Códigos de erro
Os endpoints da API do MenuGaze retornam códigos de status HTTP padrão. As respostas de erro incluem um corpo JSON com detalhes sobre o que deu errado.
Formato da resposta de erro
{
"success": false,
"error": "Human-readable error message"
}
Códigos de status
| Código | Significado | Causas comuns |
|---|---|---|
200 |
OK | A requisição foi bem-sucedida. O corpo da resposta contém os dados solicitados. |
201 |
Created | Recurso criado com sucesso. Retornado pelos endpoints POST em caso de sucesso. |
400 |
Bad Request | Campos ausentes ou inválidos no corpo da requisição. Verifique se todos os campos obrigatórios estão presentes e formatados corretamente. |
401 |
Unauthorized | Token de autenticação ausente ou inválido. Certifique-se de incluir um Bearer token válido no cabeçalho Authorization. O token pode ter expirado — faça login novamente para obter um novo token. |
403 |
Forbidden | Você está autenticado, mas não tem permissão para acessar este recurso. Isso normalmente significa que você está tentando acessar ou modificar um recurso que pertence a outro restaurante. |
404 |
Not Found | O recurso solicitado não existe. Verifique se o ID no caminho da URL está correto. |
429 |
Too Many Requests | Limite de taxa excedido. Consulte o cabeçalho Retry-After para saber quantos segundos esperar antes de tentar novamente. Os endpoints de autenticação são limitados a 10 requisições a cada 15 minutos por IP. A criação de pedidos é limitada a 5 requisições por minuto por IP. |
500 |
Internal Server Error | Ocorreu um erro inesperado no servidor. Se o problema persistir, entre em contato com o suporte. Esses erros são registrados automaticamente para investigação. |
503 |
Service Unavailable | O serviço está temporariamente indisponível. Isso pode ocorrer durante manutenções ou quando um serviço externo necessário (por exemplo, o segredo do worker) não está configurado. Tente novamente após um breve intervalo. |
Limitação de taxa
Os endpoints com limite de taxa retornam o status 429 quando o limite
é excedido. A resposta inclui:
-
Cabeçalho
Retry-After— O número de segundos a esperar antes de fazer outra requisição. - Uma mensagem de erro indicando o limite de taxa que foi excedido.
Os limites de taxa são aplicados por endereço IP. Limites atuais:
| Endpoint | Limite |
|---|---|
| Login e cadastro | 10 requisições a cada 15 minutos por IP |
| Criação de pedidos | 5 requisições por minuto por IP |
| Itens relacionados | 30 requisições por minuto por IP |