限时优惠:首次付款享 30% 折扣。
公开 REST API

InboxWarm 提供公开的 邮件预热 API

以编程方式自动化预热、获取送达率数据并管理每一个邮箱 —— 27 个 REST 接口,所有方案均包含。

最后更新:

TL;DR

InboxWarm 提供公开的 REST API,涵盖 5 大类别、共 27 个接口 —— 邮箱账户、预热、送达率、报告和系统。您可以通过它连接邮箱、启动和停止预热,并将送达率评分和报告接入您自己的工具中。所有方案均包含此访问权限,无需额外付费:注册账户,在 Developer Kit > API Integration 中生成密钥,5 分钟内即可完成第一次调用。

为何选择 API

为什么要使用 InboxWarm API?

InboxWarm API 让您可以从自己的产品、脚本和仪表盘中运行邮件预热和送达率监控,而无需使用 InboxWarm 网页应用。

自动化预热的启动与停止

在新邮箱开通的那一刻立即启动预热,并在营销活动上线时暂停 —— 无需在仪表盘中点击操作。

将送达率数据接入您自己的仪表盘

将设置评分、DNS 健康状况、收件箱送达情况和每日预热报告直接接入您的 BI 工具或内部管理后台。

将 InboxWarm 接入您的产品或内部工具

通过简单的 REST 调用,在您的引导流程、CRM 或代理商后台中以编程方式管理邮箱。

所有方案均包含,无需额外付费

每个 InboxWarm 方案都自带完整的 API 访问权限,无需额外费用 —— 立即生成密钥并开始调用接口。

功能能力

使用 InboxWarm 的 API 能做什么?

邮件预热 API 涵盖 5 大类别、共 27 个 REST 接口;完整的逐一接口参考请见 公开 API 参考文档.

8 个接口

邮箱账户

连接 Gmail、Microsoft 或 SMTP/IMAP 邮箱,检查连接健康状况,并逐个或批量管理它们。

9 个接口

预热

为任意邮箱启动、停止和配置邮件预热 —— 包括在一次调用中对最多 50 个邮箱执行批量操作。

4 个接口

送达率

查看设置评分,运行实时 DNS 健康检查(SPF、DKIM、DMARC、MX),并衡量各服务商下收件箱与垃圾箱的送达比例。

4 个接口

报告

将每日预热报告、账户级仪表盘摘要以及异步 CSV 导出接入您自己的仪表盘和工具。

2 个接口

系统

存活状态和速率限制状态接口,让您无需消耗请求配额即可监控集成状态。

完整参考文档

每个接口的请求与响应示例、错误代码以及身份验证详情。

浏览 API 参考文档
快速入门

如何开始使用 InboxWarm API?

您可以在 5 分钟内完成第一次 InboxWarm API 调用:注册账户、生成 API 密钥,然后发送一次 curl 请求 —— 无需 OAuth 流程,无需安装 SDK。

  1. 1

    创建一个 InboxWarm 账户 —— 10 天免费试用无需信用卡。

  2. 2

    Developer Kit > API Integration 生成 API 密钥。

  3. 3

    调用任意接口 —— 例如,列出您已连接的邮箱账户:

GET /email-accounts
curl "https://app.inboxwarm.ai/api/v1/email-accounts?api_key=YOUR_API_KEY"

就是这样 —— 响应是一份包含您各邮箱及其预热状态的 JSON 列表。接下来,只需一次 POST 请求即可启动预热。

身份验证

如何对 InboxWarm API 进行身份验证?

每个请求都需要使用您的 API 密钥进行身份验证;密钥的传递方式取决于您使用的 HTTP 方法。

GET / DELETE

查询参数

将您的 API 密钥作为 api_key 查询参数附加到 URL 中。

?api_key=YOUR_API_KEY
POST

JSON 请求体字段

在 JSON 请求体中以 apiKey 字段的形式包含您的 API 密钥。

{ "apiKey": "YOUR_API_KEY", ... }

Developer Kit > API Integration 中生成和管理 API 密钥。每个密钥都拥有对所有接口的完整账户访问权限。

使用场景

使用 InboxWarm API 能构建什么?

团队使用 InboxWarm 邮件送达率 API 将预热和邮箱监控嵌入产品、BI 数据管道和代理商工作流中 —— 以下是三种常见模式。

1

从引导流程中触发预热

当您的产品为客户开通新的发送邮箱时,调用 POST /email-accounts 完成连接,再调用 POST /warmup-settings/{id}/start 自动开始预热 —— 邮箱会在客户完成引导流程之前就已经开始预热。

2

将每周送达率评分接入您的 BI 工具

安排一个每周执行的任务,调用 POST /deliverability-score/{id} 和 POST /reports/bulk,然后将收件箱与垃圾箱的比例推送到 Looker、Metabase 或 Google Sheets 中,让整个团队能够将送达率趋势与营销活动指标一同查看。

3

从代理商仪表盘监控客户邮箱

管理数十个客户邮箱的代理商使用 POST /email-accounts/bulk-status 和 GET /dashboard 在一个内部视图中展示身份验证错误、健康评分和预热状态 —— 并使用 POST /warmup-settings/bulk-action 批量修复问题。

速率限制与定价

速率限制是多少?API 需要付费吗?

默认速率限制为每个 API 密钥每分钟 20 次请求,且 API 访问权限包含在每个 InboxWarm 方案中,无需额外付费。

20 req/min

每个 API 密钥的默认限制。您可以随时通过 GET /rate-limit 查看实时用量 —— 该调用不计入您的配额。

$0 extra

API 访问权限包含在每个方案中 —— 没有单独的 API 套餐,没有使用费,也没有付费附加组件。详见 价格方案

常见问题

常见问题解答

是的。InboxWarm 提供公开的 REST API,涵盖 5 大类别、共 27 个接口:邮箱账户、预热、送达率、报告和系统。所有方案的每位客户均可使用,无需额外付费。

注册 InboxWarm 账户(10 天免费试用,无需信用卡),然后在应用内打开 Developer Kit > API Integration 生成和管理您的 API 密钥。每个密钥都拥有对所有接口的完整账户访问权限。

您可以连接和管理邮箱账户、启动和停止预热、读取预热设置、查看设置评分和送达率评分、运行 DNS 健康检查,并将每日预热报告和仪表盘摘要接入您自己的工具中。

InboxWarm 采用基于 HTTP 方法的混合身份验证方案:GET 和 DELETE 请求将您的 API 密钥作为 api_key 查询参数发送,而 POST 请求则将其作为 JSON 请求体中的 apiKey 字段发送。无需 OAuth 流程。

默认速率限制为每个 API 密钥每分钟 20 次请求。您可以随时通过 GET /rate-limit 查看当前用量 —— 该调用不计入您的配额。

API 访问权限包含在每个 InboxWarm 方案中,无需额外付费。没有单独的 API 套餐、使用费或付费附加组件。

是的。InboxWarm 提供带有模拟服务器的 Postman 集合,让您在编写任何代码之前就能探索和测试每个接口。您可以在应用内的 Developer Kit > API Integration 中,与您的 API 密钥一起找到它。

全部 27 个接口的逐一参考文档已公开发布在 https://inboxwarm.ai/api/docs/ —— 无需登录。

可以。使用 POST /warmup-settings/{emailAccountId}/start 和 POST /warmup-settings/{emailAccountId}/stop 来控制单个邮箱的预热,或使用 POST /warmup-settings/bulk-action 在一次调用中为最多 50 个邮箱启动或停止预热。

是的。API 包含用于账户连接(最多 20 个邮箱)、预热启动/停止(最多 50 个邮箱)、账户状态(最多 50 个邮箱)、账户删除(最多 20 个邮箱)以及每日报告(每次请求最多 50 个邮箱)的批量接口。

准备好自动化您的邮件预热了吗?

几分钟内即可获取您的 API 密钥 —— 27 个接口,10 天免费试用,无需信用卡,且每个方案均包含 API 访问权限。