Trung tâm nhà phát triển

Tài liệu API Once Email

Tài liệu công khai cho kiểm thử email tự động: xác thực, hạn mức, lỗi và quy tắc an toàn.

Tài liệu được công khai. Khóa API chỉ dành cho gói Developer đang hoạt động và được quản lý trong bảng điều khiển.
Xác thực

Gửi Authorization: Bearer oe_live_… trong mỗi yêu cầu. Khóa chỉ hiện một lần; hãy lưu trong trình quản lý bí mật, không đặt trong mã trình duyệt, log hoặc Git.

Authorization: Bearer oe_live_your_key
Quy trình điển hình
  1. 1Tạo hộp thư tạm thời và giữ ID được trả về.
  2. 2Cho hệ thống kiểm thử gửi email tới địa chỉ đó.
  3. 3Thăm dò danh sách với backoff; tránh thăm dò rỗng liên tục.
  4. 4Đọc thư mục tiêu, hoàn tất kiểm tra rồi xóa hộp thư.

Endpoint Beta riêng tư

POST /v1/inboxesGET /v1/inboxes/{inboxId}/messagesGET /v1/inboxes/{inboxId}/messages/{uid}GET /v1/inboxes/{inboxId}/messages/{uid}/attachments/{cid}DELETE /v1/inboxes/{inboxId}

Mã trạng thái

400

Yêu cầu không hợp lệ

401

Thiếu khóa hoặc khóa không hợp lệ

403

Gói hoặc tài nguyên bị từ chối

404

Không tìm thấy tài nguyên

429

Đạt giới hạn tốc độ hoặc hạn mức tháng

5xx

Dịch vụ tạm thời gặp lỗi

Khả dụng của client

Công cụ kiểm thử TypeScript và client Python đã có nền tảng triển khai. Chưa cung cấp gói công khai có thể cài đặt hoặc SDK cho mọi ngôn ngữ.

Trạng thái thanh toán

Developer dùng gói Stripe theo tháng và hạn mức API hàng tháng, không có số dư nạp trước. Thanh toán Live vẫn đóng cho đến khi hoàn tất kiểm thử thanh toán và hoàn tiền.

Phạm vi sử dụng

Chỉ dùng API trên hệ thống bạn được phép kiểm thử. Cấm spam, né chính sách, lạm dụng tài khoản, theo dõi liên lạc của người khác và lưu dữ liệu cá nhân dài hạn.

API đang được chuẩn bị cho production
Hợp đồng được công bố trước. Khóa và lệnh gọi thật chỉ mở sau khi webhook, hạn mức và hồi quy được xác minh.
Xem giá