ธีม
เอกสารสำหรับนักพัฒนา

API Reference

สร้างการผสานรวมที่มีประสิทธิภาพด้วย Icebox API เข้าถึงอีเมล รายชื่อติดต่อ และอื่นๆ ด้วยโปรแกรม

รับ API Keyคู่มือเริ่มต้นอย่างรวดเร็ว

การออกแบบ RESTful

URL ที่สะอาดและคาดเดาได้ พร้อมวิธี HTTP มาตรฐาน

ปลอดภัยโดยค่าเริ่มต้น

ตัวเลือกการยืนยันตัวตน OAuth 2.0 และ API key

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 Endpoints

สำรวจ endpoints ที่มีให้จัดเรียงตามทรัพยากร

อีเมล

ส่ง รับ และจัดการข้อความอีเมล

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สร้าง webhook
DELETE/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/sdk

Python

pip install icebox-sdk

Ruby

gem install icebox

Go

go get github.com/icebox/sdk-go

ขีดจำกัดอัตรา

ขีดจำกัดอัตรา API ขึ้นอยู่กับระดับการสมัครสมาชิกของคุณ

ระดับขีดจำกัดอัตราขีดจำกัดรายวัน
ฟรี100 คำขอ/นาที1,000/วัน
โปร1,000 คำขอ/นาที50,000/วัน
ธุรกิจ5,000 คำขอ/นาที250,000/วัน
องค์กรกำหนดเองไม่จำกัด

การยืนยันตัวตน

คำขอ API ทั้งหมดต้องมีการยืนยันตัวตนผ่าน API key หรือโทเค็น OAuth 2.0 รวมข้อมูลรับรองของคุณในส่วนหัว Authorization

Authorization: Bearer YOUR_API_KEY

พร้อมที่จะเริ่มต้นหรือยัง?

สร้าง API key และเริ่มสร้างการผสานรวมของคุณวันนี้

รับ API Keyอ่านเอกสารฉบับเต็ม →
← กลับสู่หน้าแรก