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