RESTful 设计
简洁、可预测的 URL 和标准 HTTP 方法
默认安全
OAuth 2.0 和 API 密钥认证选项
实时 Webhook
事件发生时即时获取通知
官方 SDK
适用于流行语言和框架的库
基础 URL
https://api.icebox.cool/v1快速入门
几分钟内开始使用 Icebox API。
JavaScript
// Install the SDK
npm install @icebox/sdk
// Initialize the client
import { Icebox } from '@icebox/sdk';
const icebox = new Icebox({
apiKey: 'your_api_key_here'
});
// Fetch emails from inbox
const emails = await icebox.emails.list({
folder: 'inbox',
limit: 10
});
console.log(emails);cURL 请求
curl -X GET "https://api.icebox.cool/v1/emails" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"响应
{
"data": [
{
"id": "msg_abc123",
"subject": "Welcome to Icebox",
"from": {
"email": "hello@icebox.cool",
"name": "Icebox Team"
},
"date": "2025-01-15T10:30:00Z",
"snippet": "Thanks for signing up...",
"labels": ["inbox", "unread"]
}
],
"pagination": {
"total": 156,
"page": 1,
"per_page": 10
}
}API 端点
探索按资源组织的可用端点。
邮件
发送、接收和管理电子邮件消息
GET
/emails列出所有邮件GET
/emails/{id}获取特定邮件POST
/emails发送新邮件PUT
/emails/{id}更新邮件元数据DELETE
/emails/{id}删除邮件联系人
管理您的通讯录和联系人信息
GET
/contacts列出所有联系人GET
/contacts/{id}获取特定联系人POST
/contacts创建新联系人PUT
/contacts/{id}更新联系人DELETE
/contacts/{id}删除联系人文件夹和标签
使用文件夹和标签组织邮件
GET
/folders列出所有文件夹POST
/folders创建新文件夹GET
/labels列出所有标签POST
/labels创建新标签Webhook
接收事件的实时通知
GET
/webhooks列出 Webhook 订阅POST
/webhooks创建 WebhookDELETE
/webhooks/{id}删除 Webhook账户
管理账户设置和偏好
GET
/account获取账户详情PUT
/account更新账户设置GET
/account/usage获取 API 使用统计附件
上传和下载邮件附件
GET
/attachments/{id}下载附件POST
/attachments上传附件DELETE
/attachments/{id}删除附件官方 SDK
使用我们的官方库更快地集成。
JavaScript / TypeScript
npm install @icebox/sdkPython
pip install icebox-sdkRuby
gem install iceboxGo
go get github.com/icebox/sdk-go速率限制
API 速率限制基于您的订阅等级。
等级速率限制每日限制
免费100 请求/分钟1,000/天
专业版1,000 请求/分钟50,000/天
商业版5,000 请求/分钟250,000/天
企业版自定义无限制
认证
所有 API 请求都需要通过 API 密钥或 OAuth 2.0 令牌进行认证。在 Authorization 头中包含您的凭据。
Authorization: Bearer YOUR_API_KEY