थीम
डेवलपर दस्तावेज़

API संदर्भ

Icebox API के साथ शक्तिशाली एकीकरण बनाएं। प्रोग्रामेटिक रूप से ईमेल, संपर्क और अधिक एक्सेस करें।

RESTful डिज़ाइन

साफ, पूर्वानुमानित URLs और मानक 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/webhooksWebhook सदस्यताएं सूचीबद्ध करें
POST/webhooksWebhook बनाएं
DELETE/webhooks/{id}Webhook हटाएं

खाता

खाता सेटिंग्स और प्राथमिकताएं प्रबंधित करें

GET/accountखाता विवरण प्राप्त करें
PUT/accountखाता सेटिंग्स अपडेट करें
GET/account/usageAPI उपयोग आंकड़े प्राप्त करें

अनुलग्नक

ईमेल अनुलग्नक अपलोड और डाउनलोड करें

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 कुंजी बनाएं और आज ही अपना एकीकरण बनाना शुरू करें।