Giao Diện
Tài liệu Nhà phát triển

Tham chiếu API

Xây dựng các tích hợp mạnh mẽ với Icebox API. Truy cập email, danh bạ và nhiều hơn nữa theo cách lập trình.

Thiết kế RESTful

URL sạch, dễ đoán và các phương thức HTTP tiêu chuẩn

Bảo mật Mặc định

Tùy chọn xác thực OAuth 2.0 và khóa API

Webhook Thời gian thực

Nhận thông báo ngay lập tức khi có sự kiện

SDK Chính thức

Thư viện cho các ngôn ngữ và framework phổ biến

URL Co so
https://api.icebox.cool/v1

Bắt đầu Nhanh

Bắt đầu sử dụng Icebox API trong vài phút.

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);
Yêu cầu cURL
curl -X GET "https://api.icebox.cool/v1/emails" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Phản hồi
{
  "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
  }
}

Điểm cuối API

Khám phá các điểm cuối có sẵn được sắp xếp theo tài nguyên.

Email

Gửi, nhận và quản lý tin nhắn email

GET/emailsLiệt kê tất cả email
GET/emails/{id}Lấy email cụ thể
POST/emailsGửi email mới
PUT/emails/{id}Cập nhật siêu dữ liệu email
DELETE/emails/{id}Xóa email

Danh ba

Quản lý sổ địa chỉ và thông tin liên lạc của bạn

GET/contactsLiệt kê tất cả danh bạ
GET/contacts/{id}Lấy danh bạ cụ thể
POST/contactsTạo danh bạ mới
PUT/contacts/{id}Cập nhật danh bạ
DELETE/contacts/{id}Xóa danh bạ

Thư mục và Nhãn

Sắp xếp email với thư mục và nhãn

GET/foldersLiệt kê tất cả thư mục
POST/foldersTạo thư mục mới
GET/labelsLiệt kê tất cả nhãn
POST/labelsTạo nhãn mới

Webhook

Nhận thông báo thời gian thực cho các sự kiện

GET/webhooksLiệt kê đăng ký webhook
POST/webhooksTạo webhook
DELETE/webhooks/{id}Xóa webhook

Tài khoản

Quản lý cài đặt và tùy chọn tài khoản

GET/accountLấy chi tiết tài khoản
PUT/accountCập nhật cài đặt tài khoản
GET/account/usageLấy thống kê sử dụng API

Tệp đính kèm

Tải lên và tải xuống tệp đính kèm email

GET/attachments/{id}Tải xuống tệp đính kèm
POST/attachmentsTải lên tệp đính kèm
DELETE/attachments/{id}Xóa tệp đính kèm

SDK Chính thức

Sử dụng thư viện chính thức của chúng tôi để tích hợp nhanh hơn.

JavaScript / TypeScript

npm install @icebox/sdk

Python

pip install icebox-sdk

Ruby

gem install icebox

Go

go get github.com/icebox/sdk-go

Giới hạn Tốc độ

Giới hạn tốc độ API dựa trên cấp độ đăng ký của bạn.

Cấp độGiới hạn Tốc độGiới hạn Hàng ngày
Miễn phí100 yêu cầu/phút1.000/ngay
Pro1.000 yêu cầu/phút50.000/ngay
Doanh nghiệp5.000 yêu cầu/phút250.000/ngay
Doanh nghiệp lớnTùy chỉnhKhông giới hạn

Xác thực

Tất cả yêu cầu API yêu cầu xác thực qua khóa API hoặc token OAuth 2.0. Bao gồm thông tin xác thực của bạn trong header Authorization.

Authorization: Bearer YOUR_API_KEY

Sẵn sàng bắt đầu?

Tạo khóa API và bắt đầu xây dựng tích hợp của bạn ngay hôm nay.