Тема
Документация для разработчиков

Справочник API

Создавайте мощные интеграции с Icebox API. Программный доступ к электронной почте, контактам и многому другому.

RESTful дизайн

Чистые, предсказуемые URL и стандартные HTTP-методы

Безопасность по умолчанию

Варианты аутентификации OAuth 2.0 и API-ключ

Webhooks в реальном времени

Мгновенные уведомления при возникновении событий

Официальные 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

Изучите доступные конечные точки, организованные по ресурсам.

Письма

Отправка, получение и управление сообщениями

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Список подписок на 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-ключ или токен OAuth 2.0. Включите свои учетные данные в заголовок Authorization.

Authorization: Bearer YOUR_API_KEY

Готовы начать?

Создайте API-ключ и начните строить интеграцию сегодня.