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

Довідник 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-ключ і почніть будувати інтеграцію сьогодні.