Miễn phí · Không cần đăng ký

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.

API hiện chưa được kích hoạt.

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.

Liên hệ ↗
01 / KẾT NỐI

Địa chỉ API

https://mail.srimpz.com/api/v1

Các endpoint trả về JSON. Địa chỉ hộp thư phải thuộc tên miền @srimpz.com.

02 / XÁC THỰC

Gửi khoá trong header

x-api-key: YOUR_KEY

Bạ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
GET/inbox/:address

Danh sách thư

Trả về địa chỉ, số lượng và metadata của thư trong hộp thư.

GET/latest/:address

Thư mới nhất

Nội dung đầy đủ: text, HTML, mã OTP và thông tin tệp đính kèm.

GET/otp/:address?wait=60

Mã 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.

GET/message/:id

Chi 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.
GET /otp/:address
curl -H "x-api-key: YOUR_KEY" \
  "https://mail.srimpz.com/api/v1/otp/yourname@srimpz.com?wait=60"
GET /latest/:address
curl -H "x-api-key: YOUR_KEY" \
  "https://mail.srimpz.com/api/v1/latest/yourname@srimpz.com"
Khi nhận được OTP

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.
200

Yê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.

401

Thiếu hoặc sai khoá

Kiểm tra header x-api-key và khoá đã được cấp.

404

Chư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.

503

API chưa kích hoạt

Liên hệ quản trị viên để bật API và cấp khoá truy cập.