Monitoraggio delle API

I monitor API inviano una richiesta HTTP configurabile a un endpoint ogni 30 secondi e ti avvisano quando è irraggiungibile, lento o restituisce dati sbagliati. Controlli metodo, header, body e autenticazione, e verifichi codice di stato, body JSON, header e tempo di risposta.

Come per gli altri monitor, se un monitor API rileva un problema puoi lavorare con il tuo team per risolvere l'incidente e, se vuoi, aggiornare la tua status page.

Cosa controlla un monitor API?

• Testa i tuoi endpoint API da varie località nel mondo ogni 30 secondi.
• Verifica codici di stato HTTP, body JSON, header e tempi di risposta.
• Includi header personalizzati, parametri query o payload JSON.
• Ricevi notifiche immediate se un endpoint è giù, lento o restituisce risultati inattesi.
• Integra Slack, email, SMS, chiamate, webhook e altro ancora.

Come aggiungo un monitor API?

Vai al tuo progetto → Monitor → Aggiungi monitor, scegli API, inserisci l'URL dell'endpoint, configura la richiesta e imposta le asserzioni che indicano che l'endpoint funziona correttamente.

Tipo di monitor

Scegli API come tipo di monitor.

Inserisci l'URL dell'endpoint che vuoi monitorare — per esempio,
https://api.iltuoservizio.com/v1/users.

Configurazione della richiesta

Puoi personalizzare completamente la tua richiesta API:

• Metodo HTTP: GET, POST, PUT, PATCH, DELETE, OPTIONS o HEAD
• Body: invia JSON, dati form, GraphQL o testo semplice insieme alla richiesta
• Autenticazione: aggiungi autenticazione basic, chiave API o token Bearer
• Parametri query: aggiungi coppie chiave/valore all'URL della richiesta
• Header: aggiungi gli header personalizzati richiesti dalla tua API

Il monitor ha successo se

Un monitor API ha successo quando tutte le asserzioni indicate sono soddisfatte.
Puoi impostare una o più delle seguenti asserzioni:

• Codice di stato: ad esempio la risposta è 200 OK
• Tempo di risposta: ad esempio sotto 1 secondo
• Il body contiene: ad esempio "success": true
• Percorso JSON: ad esempio data.status uguale a "active"
• L'header contiene: ad esempio Content-Type: application/json

Se una di queste condizioni non è soddisfatta, il monitor viene contrassegnato come giù e gli avvisi vengono inviati in base alle tue impostazioni degli avvisi.

Impostazioni avanzate

• Nome descrittivo: assegna al monitor un nome descrittivo per riconoscerlo più facilmente.
• Esegui i controlli ogni: decidi con quale frequenza testare l'endpoint.
• Esegui da: scegli le località dei test (Stati Uniti, Canada, Europa, Asia).
• Aggiungi alla status page: mostra pubblicamente l'uptime e le statistiche di risposta della tua API.
• Quando un monitor fallisce: apri un incidente, avvisa gli iscritti o pubblica sulla status page.
• Quando un monitor si ripristina: risolvi gli incidenti e aggiorna automaticamente la status page.