ערכת נושא
תיעוד למפתחים

הפניית API

בנו אינטגרציות חזקות עם Icebox API. גישה לאימיילים, אנשי קשר ועוד באופן תכנותי.

קבל מפתח APIמדריך התחלה מהירה

עיצוב RESTful

כתובות URL נקיות וצפויות ושיטות HTTP סטנדרטיות

מאובטח כברירת מחדל

אפשרויות אימות OAuth 2.0 ומפתח API

Webhooks בזמן אמת

קבל התראות מיידיות כאשר מתרחשים אירועים

SDKs רשמיים

ספריות לשפות ומסגרות פופולריות

כתובת 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צור תווית חדשה

Webhooks

קבל התראות בזמן אמת על אירועים

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}מחק קובץ מצורף

SDKs רשמיים

השתמש בספריות הרשמיות שלנו לאינטגרציה מהירה יותר.

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 או טוקן OAuth 2.0. כלול את האישורים שלך בכותרת Authorization.

Authorization: Bearer YOUR_API_KEY

מוכן להתחיל?

צור מפתח API והתחל לבנות את האינטגרציה שלך היום.

קבל מפתח APIקרא תיעוד מלא →
חזרה לדף הבית →