Giám sát API

Monitor API cho phép bạn tự động xác minh rằng các endpoint API của mình truy cập được, hoạt động hiệu quả và trả về dữ liệu đúng. Quá trình này giúp đảm bảo ứng dụng và tích hợp của bạn hoạt động như dự kiến.

Tương tự các monitor khác, nếu một monitor API phát hiện vấn đề, bạn có thể làm việc cùng nhóm để khắc phục sự cố và tùy chọn cập nhật trang trạng thái của mình.

Tính năng chính

• Kiểm thử các endpoint API từ nhiều vị trí trên toàn cầu, mỗi 30 giây một lần.
• Xác thực mã trạng thái HTTP, nội dung JSON, header và thời gian phản hồi.
• Đính kèm header tùy chỉnh, tham số query, hoặc payload JSON.
• Nhận thông báo ngay lập tức nếu một endpoint gặp sự cố, chậm, hoặc trả về kết quả bất thường.
• Tích hợp với Slack, email, SMS, cuộc gọi điện thoại, webhook và nhiều kênh khác.

Thêm monitor API đầu tiên của bạn

Để tạo một monitor, hãy vào dự án của bạn → Monitor → Thêm monitor.

Loại monitor

Chọn API làm loại monitor.

Nhập URL endpoint bạn muốn giám sát — ví dụ,
https://api.yourservice.com/v1/users.

Cấu hình yêu cầu

Bạn có thể tùy chỉnh hoàn toàn yêu cầu API của mình:

• Phương thức HTTP: GET, POST, PUT, PATCH, DELETE, OPTIONS, hoặc HEAD
• Nội dung: Gửi JSON, dữ liệu form, GraphQL, hoặc văn bản thuần cùng với yêu cầu
• Xác thực: Thêm xác thực cơ bản, khóa API, hoặc token Bearer
• Tham số query: Nối các cặp khóa/giá trị vào URL yêu cầu
• Header: Thêm các header tùy chỉnh mà yêu cầu API của bạn cần

Monitor thành công nếu

Một monitor API thành công khi mọi điều kiện được chỉ định đều được thỏa mãn.
Bạn có thể đặt một hoặc nhiều điều kiện sau:

• Mã trạng thái: ví dụ phản hồi là 200 OK
• Thời gian phản hồi: ví dụ dưới 1 giây
• Nội dung chứa: ví dụ "success": true
• Đường dẫn JSON: ví dụ data.status bằng "active"
• Header chứa: ví dụ Content-Type: application/json

Nếu bất kỳ điều kiện nào không được đáp ứng, monitor sẽ được đánh dấu là gặp sự cố, và cảnh báo sẽ được gửi dựa trên cài đặt cảnh báo của bạn.

Cài đặt nâng cao

• Tên gợi nhớ: Đặt cho monitor một tên mô tả rõ ràng để dễ nhận biết.
• Chạy kiểm tra mỗi: Quyết định tần suất kiểm thử endpoint.
• Chạy từ: Chọn vị trí kiểm thử (Hoa Kỳ, Canada, Châu Âu, Châu Á).
• Thêm vào trang trạng thái: Công khai thời gian hoạt động và thống kê phản hồi của API.
• Khi một monitor gặp sự cố: Khởi tạo một sự cố, thông báo cho người đăng ký, hoặc đăng lên trang trạng thái.
• Khi một monitor phục hồi: Khắc phục sự cố và tự động cập nhật trang trạng thái của bạn.