Pemantauan API

Monitor API mengirim permintaan HTTP yang bisa dikonfigurasi ke sebuah endpoint setiap 30 detik dan memberi tahu Anda saat endpoint tidak bisa dijangkau, lambat, atau mengembalikan data yang salah. Anda mengatur metode, header, body, dan autentikasi, serta menguji kode status, body JSON, header, dan waktu respons.

Serupa dengan monitor lainnya, jika monitor API menemukan masalah, Anda bisa bekerja sama dengan tim untuk menyelesaikan insidennya dan, jika mau, memperbarui halaman status Anda.

Apa yang diperiksa monitor API?

• Menguji endpoint API Anda dari berbagai lokasi global setiap 30 detik.
• Memvalidasi kode status HTTP, body JSON, header, dan waktu respons.
• Menyertakan header khusus, parameter query, atau payload JSON.
• Menerima notifikasi langsung jika sebuah endpoint mati, lambat, atau mengembalikan hasil yang tidak diharapkan.
• Terintegrasi dengan Slack, email, SMS, panggilan telepon, webhook, dan lainnya.

Bagaimana cara menambahkan monitor API?

Buka proyek Anda → Monitor → Tambahkan monitor, pilih API, masukkan URL endpoint, konfigurasikan permintaan, lalu tetapkan pernyataan yang menandakan endpoint berjalan sehat.

Jenis monitor

Pilih API sebagai jenis monitornya.

Masukkan URL endpoint yang ingin Anda pantau — misalnya,
https://api.yourservice.com/v1/users.

Konfigurasi permintaan

Anda bisa menyesuaikan permintaan API Anda sepenuhnya:

• Metode HTTP: GET, POST, PUT, PATCH, DELETE, OPTIONS, atau HEAD
• Body: Kirim JSON, data form, GraphQL, atau teks biasa bersama permintaan Anda
• Autentikasi: Tambahkan basic authentication, kunci API, atau otorisasi Bearer token
• Parameter query: Tambahkan pasangan kunci/nilai ke URL permintaan Anda
• Header: Tambahkan header khusus yang dibutuhkan permintaan API Anda

Monitor dianggap berhasil jika

Monitor API berhasil bila semua pernyataan yang ditentukan terpenuhi.
Anda bisa menetapkan satu atau lebih pernyataan berikut:

• Kode status: mis. respons adalah 200 OK
• Waktu respons: mis. di bawah 1 detik
• Body berisi: mis. "success": true
• Path JSON: mis. data.status sama dengan "active"
• Header berisi: mis. Content-Type: application/json

Jika salah satu kondisi ini tidak terpenuhi, monitor akan ditandai mati, dan peringatan akan dikirim berdasarkan pengaturan peringatan Anda.

Pengaturan lanjutan

• Nama ramah: Beri monitor Anda nama deskriptif agar mudah dikenali.
• Jalankan pemeriksaan setiap: Tentukan seberapa sering endpoint diuji.
• Jalankan dari: Pilih lokasi pengujian (Amerika Serikat, Kanada, Eropa, Asia).
• Tambahkan ke halaman status: Tampilkan uptime API dan statistik respons secara publik.
• Saat monitor gagal: Mulai sebuah insiden, beri tahu pelanggan langganan, atau terbitkan ke halaman status Anda.
• Saat monitor pulih: Selesaikan insiden dan perbarui halaman status Anda secara otomatis.