开发者中心

Once Email API 文档

面向自动化邮件测试的公开开发者文档:鉴权、配额、错误处理和安全使用原则。

文档对所有人开放。API 密钥只向有效 Developer 订阅提供,并且只在账号仪表盘中管理。
鉴权

每次请求使用 Authorization: Bearer oe_live_…。密钥只在创建时显示一次;请存入密钥管理器,不要放进浏览器代码、日志或 Git 仓库。

Authorization: Bearer oe_live_your_key
典型流程
  1. 1创建临时收件箱并保存返回的邮箱 ID。
  2. 2让你的测试系统向该地址发送邮件。
  3. 3轮询邮件列表;采用退避策略,不要高频空轮询。
  4. 4读取目标邮件,完成断言后立即删除收件箱。

私有 Beta 接口

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

状态码

400

请求无效

401

密钥缺失或无效

403

方案或资源被拒绝

404

资源不存在

429

达到频率或月度配额

5xx

服务暂时失败

客户端可用状态

TypeScript 测试工具和 Python 客户端已有实现基础。当前尚未提供可安装的公开客户端包,也不提供全语言 SDK。

计费状态

Developer 方案采用 Stripe 月度订阅和月度 API 配额,不提供储值充值。完成真实付款、退款等门禁前,Live 结账保持关闭。

使用边界

本 API 只用于你有权测试的系统。禁止垃圾邮件、绕过平台规则、账号滥用、监控他人通信或长期保存个人数据。邮箱正文和附件不进入账号历史。

API 正在进入生产准备阶段
公开合同先行发布,密钥创建和真实调用将在支付 Webhook、配额和回归门禁全部通过后开放。
查看价格