DEVELOPER RESOURCES
Hộp thư, trong quy trình của bạn.
Nhận thư và mã OTP bằng những yêu cầu HTTP đơn giản.
Khoá truy cập do quản trị viên cấp. Liên hệ hỗ trợ để được cấp khoá và kích hoạt API trước khi dùng các ví dụ bên dưới.
Địa chỉ API
https://mail.srimpz.com/api/v1Các endpoint trả về JSON. Địa chỉ hộp thư phải thuộc tên miền @srimpz.com.
Gửi khoá trong header
x-api-key: YOUR_KEYBạn cũng có thể dùng Authorization: Bearer YOUR_KEY. Giữ khoá trong ứng dụng phía máy chủ, tránh đưa vào mã trình duyệt công khai.
Bốn endpoint cần thiết
API v1/inbox/:addressDanh sách thư
Trả về địa chỉ, số lượng và metadata của thư trong hộp thư.
/latest/:addressThư mới nhất
Nội dung đầy đủ: text, HTML, mã OTP và thông tin tệp đính kèm.
/otp/:address?wait=60Mã OTP mới nhất
Tìm mã trong thư mới nhất có OTP. wait là số giây chờ, tối đa 120.
/message/:idChi tiết một thư
Lấy nội dung đầy đủ của thư theo ID đã nhận từ danh sách.
Bắt đầu với một yêu cầu
Thay YOUR_KEY bằng khoá của bạn.curl -H "x-api-key: YOUR_KEY" \
"https://mail.srimpz.com/api/v1/otp/yourname@srimpz.com?wait=60"curl -H "x-api-key: YOUR_KEY" \
"https://mail.srimpz.com/api/v1/latest/yourname@srimpz.com"Phản hồi có address, code, candidates, from, subject, date và messageId. Nếu chưa có mã, wait cho phép chờ thư đến trong cùng yêu cầu.
Hiểu mã phản hồi
Lỗi được trả về dưới dạng JSON với trường error.200Yêu cầu thành công
Đọc dữ liệu trong phản hồi JSON.
400Địa chỉ không hợp lệ
Dùng địa chỉ thuộc @srimpz.com.
401Thiếu hoặc sai khoá
Kiểm tra header x-api-key và khoá đã được cấp.
404Chưa tìm thấy dữ liệu
Hộp thư chưa có thư, mã OTP chưa đến hoặc ID không tồn tại.
503API chưa kích hoạt
Liên hệ quản trị viên để bật API và cấp khoá truy cập.