Source: https://once-email.com/vi/api Tài liệu nhà phát triển Tài liệu nhà phát triển API # 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. Việc tạo khóa API và gọi API thực tế chưa mở cho công chúng. Quy trình dưới đây chỉ dành cho người kiểm thử đã được cấp quyền truy cập API rõ ràng và có thông tin xác thực hợp lệ. 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 cho người kiểm thử được phép 1. Chỉ tiếp tục khi đã được cấp quyền truy cập API rõ ràng và thông tin xác thực hợp lệ với quyền tối thiểu cần thiết. Lưu chúng trong cơ chế quản lý bí mật của tiến trình; nếu chưa có quyền truy cập, chỉ xem tài liệu và nội dung tải xuống. Tạo hộp thư tạm thời và giữ ID được trả về. 2. Cho hệ thống kiểm thử gửi email tới địa chỉ đó. 3. Thăm dò danh sách với backoff; tránh thăm dò rỗng liên tục. 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/inboxes `` GET /v1/inboxes/{inboxId}/messages `` GET /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 ` 413 ` Phản hồi hoặc tệp quá lớn ` 429 ` Đạt giới hạn tốc độ hoặc hạn mức tháng ` 503 ` Dịch vụ tạm thời gặp lỗi Khả dụng của client Đã có ứng viên mã nguồn mở cho TypeScript, Python, Java, Go, .NET, PHP và Ruby. CI native đạt trên Linux, macOS và Windows; chưa phát hành lên registry 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 Tài liệu công khai và bản tải xuống trước phát hành không cấp quyền truy cập API. Việc tạo khóa API và gọi API thực tế chưa mở cho công chúng. [Xem SDK]() Xem giá API Demo ## Ví dụ an toàn đa nền tảng Dành cho hệ thống sở hữu hoặc được phép; chạy bằng Node.js 20+ trên Windows, Linux và macOS. ``` node demos/api/authorized-workflow.mjs ONCE_EMAIL_API_KEY <- process secret facility create inbox -> list messages -> finally delete inbox ``` [Mở demo đầy đủ]() Hướng dẫn sử dụng đầy đủ ## Tải gói cục bộ có phiên bản Chỉ kiểm thử ứng dụng của bạn hoặc được ủy quyền. Once Email chỉ nhận email. Tài liệu và mã nguồn công khai; API được kiểm soát, SDK và Skill là ứng viên ngoài registry. Tài liệu công khai và bản tải xuống trước phát hành không cấp quyền truy cập API. Việc tạo khóa API và gọi API thực tế chưa mở cho công chúng. Kiểm tra SHA256SUMS trước khi giải nén. [Tải gói]() [SHA256SUMS]() Điểm bắt đầu cục bộ chính xác ``` node demos/api/authorized-workflow.mjs ``` ## Từ tải xuống đến dọn dẹp 1. Xác nhận sở hữu hoặc ủy quyền; chỉ dùng local, test, staging. 2. Chỉ tiếp tục khi đã được cấp quyền truy cập API rõ ràng và thông tin xác thực hợp lệ với quyền tối thiểu cần thiết. Lưu chúng trong cơ chế quản lý bí mật của tiến trình; nếu chưa có quyền truy cập, chỉ xem tài liệu và nội dung tải xuống. 3. Tải, xác minh, giải nén và đọc tài liệu. 4. Chạy Demo bằng Node.js 20+ và kích hoạt email có dấu. 5. Thăm dò có hạn chót và chỉ đọc kết quả duy nhất. 6. Xóa trong finally; báo lỗi dọn dẹp riêng. ## Lỗi và khôi phục Phân biệt 400/401/403/404/413/429/503, timeout, mơ hồ, trích xuất, kiểm tra và dọn dẹp. Chỉ thử lại trong một hạn chót. [Xem mã nguồn công khai]() [Đọc hướng dẫn thực hành]()