Motiv
Dokumentace pro vyvojare

API Reference

Vytvarejte vykonoe integrace s Icebox API. Programovy pristup k emailum, kontaktum a dalsimu.

RESTful design

Ciste, predvidatelne URL a standardni HTTP metody

Bezpecny ve vychozim nastaveni

Moznosti autentifikace OAuth 2.0 a API klic

Webhooky v realnem case

Okamzita upozorneni pri vzniku udalosti

Oficialni SDK

Knihovny pro popularni jazyky a frameworky

Zakladni URL
https://api.icebox.cool/v1

Rychly start

Zacnete pouzivat Icebox API behem nekolika 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 pozadavek
curl -X GET "https://api.icebox.cool/v1/emails" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Odpoved
{
  "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 dostupne koncove body organizovane podle zdroju.

Emaily

Odesilani, prijimani a sprava emailovych zprav

GET/emailsSeznam vsech emailu
GET/emails/{id}Ziskat konkretni email
POST/emailsOdeslat novy email
PUT/emails/{id}Aktualizovat metadata emailu
DELETE/emails/{id}Smazat email

Kontakty

Sprava adresare a kontaktnich informaci

GET/contactsSeznam vsech kontaktu
GET/contacts/{id}Ziskat konkretni kontakt
POST/contactsVytvorit novy kontakt
PUT/contacts/{id}Aktualizovat kontakt
DELETE/contacts/{id}Smazat kontakt

Slozky a stitky

Organizace emailu pomoci slozek a stitku

GET/foldersSeznam vsech slozek
POST/foldersVytvorit novou slozku
GET/labelsSeznam vsech stitku
POST/labelsVytvorit novy stitek

Webhooky

Prijimani upozorneni na udalosti v realnem case

GET/webhooksSeznam odberu webhooku
POST/webhooksVytvorit webhook
DELETE/webhooks/{id}Smazat webhook

Ucet

Sprava nastaveni a preferencí uctu

GET/accountZiskat udaje o uctu
PUT/accountAktualizovat nastaveni uctu
GET/account/usageZiskat statistiky pouziti API

Prilohy

Nahravani a stahovani prilonh

GET/attachments/{id}Stahnout prilohu
POST/attachmentsNahrat prilohu
DELETE/attachments/{id}Smazat prilohu

Oficialni SDK

Pouzijte nase oficialni knihovny pro rychlejsi 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 pozadavku

Limity API zavisi na urovni predplatneho.

UrovenLimit pozadavkuDenni limit
Zdarma100 pozadavku/min1 000/den
Pro1 000 pozadavku/min50 000/den
Business5 000 pozadavku/min250 000/den
EnterpriseVlastniNeomezeno

Autentifikace

Vsechny pozadavky API vyzaduji autentifikaci pomoci API klice nebo tokenu OAuth 2.0. Zahrnte sve prihlasovaci udaje do hlavicky Authorization.

Authorization: Bearer YOUR_API_KEY

Jste pripraveni zacit?

Vytvorte API klic a zacnete budovat integraci jeste dnes.