وثائق المطورين
مرجع API
قم ببناء تكاملات قوية مع Icebox 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إنشاء تسمية جديدةخطافات الويب
تلقي إشعارات فورية للأحداث
GET
/webhooksعرض اشتراكات WebhookPOST
/webhooksإنشاء WebhookDELETE
/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/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