Ett anrop görs när en användare som har aktiverat din app visar appens sida eller klickar på fliken Status & felsökning under Appar.
POST https://yourapp.com/status
Upsales skickar ett POST-anrop med en JSON-body. Body:n har samma egenskaper som alla andra anrop till din app, se Anropets body (på engelska). Appens endpoint måste använda HTTPS.
Använd den här endpointen om din app har pågående problem, om appens konfiguration inte fungerar eller helt enkelt för att visa att allt fungerar och är igång.
Statuskod
Svara med den statuskod som bäst motsvarar appens status just nu.
200
Vi visar för användaren att din app är igång. Andra 2xx-koder rapporterar ingen status.
404
Vi visar för användaren att din app ännu inte har implementerat någon statusrapport.
3xx, 4xx och 5xx (utom 404)
Vi visar för användaren att din app har pågående problem. Använd egenskapen message i svarets body för att förklara varför.
Inget svar
Om din app inte svarar alls, eller inte svarar inom 30 sekunder, visar vi att appen är nere just nu.
Svarets body
Oavsett om du svarar med en lyckad statuskod eller inte visar vi allt som står i egenskapen message i ditt svar för användaren.
{
"message": "Din konfiguration fungerar inte."
}
Proffstips när du svarar
- Använd markdown för att formatera svarsmeddelandet. HTML rensas ned till grundläggande formateringstaggar, så skriv länkar som markdown-länkar.
- Kontrollera konfigurationen som du får i body:n för att se om det finns något problem med användarens konfiguration.
- Använd egenskapen message för vanliga felsökningsråd, även om appen i stort sett fungerar som den ska.