Motiv
Dokumentace pro vyvojare

Reference API

Vytvářejte výkonné integrace s Icebox API. Programový přístup k emailům, kontaktům a dalšímu.

Získat API klíčPrůvodce rychlým startem

RESTful design

Čisté, předvídatelné URL a standardní HTTP metody

Bezpečný ve výchozím nastavení

Možnosti autentifikace OAuth 2.0 a API klíč

Webhooky v reálném čase

Okamžitá upozornění při vzniku událostí

Oficialni SDK

Knihovny pro popularni jazyky a frameworky

Základní URL
https://api.icebox.cool/v1

Rychlý start

Začněte používat Icebox API během několika minut.

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 požadavek
curl -X GET "https://api.icebox.cool/v1/emails" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Odpověď
{
  "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 Endpointy

Prozkoumejte dostupné koncové body organizované podle zdrojů.

Emaily

Odesílání, přijímání a správa emailových zpráv

GET/emailsSeznam všech emailů
GET/emails/{id}Získat konkrétní email
POST/emailsOdeslat nový email
PUT/emails/{id}Aktualizovat metadata emailu
DELETE/emails/{id}Smazat email

Kontakty

Správa adresáře a kontaktních informací

GET/contactsSeznam všech kontaktů
GET/contacts/{id}Získat konkrétní kontakt
POST/contactsVytvořit nový kontakt
PUT/contacts/{id}Aktualizovat kontakt
DELETE/contacts/{id}Smazat kontakt

Složky a štítky

Organizace emailů pomocí složek a štítků

GET/foldersSeznam všech složek
POST/foldersVytvořit novou složku
GET/labelsSeznam všech štítků
POST/labelsVytvořit nový štítek

Webhooky

Přijímání upozornění na události v reálném čase

GET/webhooksSeznam odberu webhooku
POST/webhooksVytvořit webhook
DELETE/webhooks/{id}Smazat webhook

Účet

Sprava nastaveni a preferencí uctu

GET/accountZískat údaje o účtu
PUT/accountAktualizovat nastaveni uctu
GET/account/usageZískat statistiky použití API

Přílohy

Nahrávání a stahování příloh

GET/attachments/{id}Stáhnout přílohu
POST/attachmentsNahrát přílohu
DELETE/attachments/{id}Smazat přílohu

Oficialni SDK

Použijte naše oficiální knihovny pro rychlejší integraci.

JavaScript / TypeScript

npm install @icebox/sdk

Python

pip install icebox-sdk

Ruby

gem install icebox

Go

go get github.com/icebox/sdk-go

Limity požadavků

Limity API závisí na úrovni předplatného.

ÚroveňLimit požadavkůDenní limit
Zdarma100 požadavků/min1 000/den
Pro1 000 požadavků/min50 000/den
Business5 000 požadavků/min250 000/den
EnterpriseVlastníNeomezeno

Autentifikace

Všechny požadavky API vyžadují autentifikaci pomocí API klíče nebo tokenu OAuth 2.0. Zahrňte své přihlašovací údaje do hlavičky Authorization.

Authorization: Bearer YOUR_API_KEY

Jste připraveni začít?

Vytvořte API klíč a začněte budovat integraci ještě dnes.

Získat API klíčPřečíst úplnou dokumentaci →
← Zpět na domovskou stránku