Vai al contenuto principale

Riferimento API

Codici di errore

Codici di errore

Gli endpoint dell'API di MenuGaze restituiscono codici di stato HTTP standard. Le risposte di errore includono un corpo JSON con i dettagli su cosa è andato storto.

Formato della risposta di errore

{
  "success": false,
  "error": "Human-readable error message"
}

Codici di stato

Codice Significato Cause comuni
200 OK Richiesta riuscita. Il corpo della risposta contiene i dati richiesti.
201 Created Risorsa creata correttamente. Restituito dagli endpoint POST in caso di successo.
400 Bad Request Campi mancanti o non validi nel corpo della richiesta. Verifichi che tutti i campi obbligatori siano presenti e formattati correttamente.
401 Unauthorized Token di autenticazione mancante o non valido. Si assicuri di includere un token Bearer valido nell'header Authorization. Il token potrebbe essere scaduto: effettui di nuovo l'accesso per ottenere un nuovo token.
403 Forbidden È autenticato ma non ha l'autorizzazione per accedere a questa risorsa. Di solito significa che sta cercando di accedere a una risorsa appartenente a un altro ristorante o di modificarla.
404 Not Found La risorsa richiesta non esiste. Verifichi che l'ID nel percorso dell'URL sia corretto.
429 Too Many Requests Limite di frequenza superato. Controlli l'header Retry-After per conoscere il numero di secondi da attendere prima di riprovare. Gli endpoint di autenticazione sono limitati a 10 richieste ogni 15 minuti per IP. La creazione degli ordini è limitata a 5 richieste al minuto per IP.
500 Internal Server Error Si è verificato un errore imprevisto sul server. Se il problema persiste, contatti l'assistenza. Questi errori vengono registrati automaticamente per essere analizzati.
503 Service Unavailable Il servizio è temporaneamente non disponibile. Può accadere durante la manutenzione o quando un servizio esterno necessario (ad es. il worker secret) non è configurato. Riprovi dopo una breve attesa.

Limitazione della frequenza

Gli endpoint con limiti di frequenza restituiscono uno stato 429 quando il limite viene superato. La risposta include:

  • Header Retry-After — Il numero di secondi da attendere prima di effettuare un'altra richiesta.
  • Un messaggio di errore che indica il limite di frequenza superato.

I limiti di frequenza vengono applicati per indirizzo IP. Limiti attuali:

Endpoint Limite
Accesso e registrazione 10 richieste ogni 15 minuti per IP
Creazione degli ordini 5 richieste al minuto per IP
Articoli correlati 30 richieste al minuto per IP