Tema
Documentacao para Desenvolvedores

Referencia da API

Crie integracoes poderosas com a API do Icebox. Acesse emails, contatos e mais de forma programatica.

Design RESTful

URLs limpas e previsiveis com metodos HTTP padrao

Seguro por Padrao

Opcoes de autenticacao OAuth 2.0 e chave de API

Webhooks em Tempo Real

Receba notificacoes instantaneas quando eventos ocorrem

SDKs Oficiais

Bibliotecas para linguagens e frameworks populares

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

Inicio Rapido

Comece a usar a API do Icebox em minutos.

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);
Requisicao cURL
curl -X GET "https://api.icebox.cool/v1/emails" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Resposta
{
  "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
  }
}

Endpoints da API

Explore os endpoints disponiveis organizados por recurso.

Emails

Envie, receba e gerencie mensagens de email

GET/emailsListar todos os emails
GET/emails/{id}Obter um email especifico
POST/emailsEnviar um novo email
PUT/emails/{id}Atualizar metadados do email
DELETE/emails/{id}Excluir um email

Contatos

Gerencie sua agenda de enderecos e informacoes de contato

GET/contactsListar todos os contatos
GET/contacts/{id}Obter um contato especifico
POST/contactsCriar um novo contato
PUT/contacts/{id}Atualizar um contato
DELETE/contacts/{id}Excluir um contato

Pastas e Etiquetas

Organize emails com pastas e etiquetas

GET/foldersListar todas as pastas
POST/foldersCriar uma nova pasta
GET/labelsListar todas as etiquetas
POST/labelsCriar uma nova etiqueta

Webhooks

Receba notificacoes em tempo real para eventos

GET/webhooksListar inscricoes de webhook
POST/webhooksCriar um webhook
DELETE/webhooks/{id}Excluir um webhook

Conta

Gerencie configuracoes e preferencias da conta

GET/accountObter detalhes da conta
PUT/accountAtualizar configuracoes da conta
GET/account/usageObter estatisticas de uso da API

Anexos

Faca upload e download de anexos de email

GET/attachments/{id}Baixar anexo
POST/attachmentsEnviar anexo
DELETE/attachments/{id}Excluir anexo

SDKs Oficiais

Use nossas bibliotecas oficiais para integrar mais rapido.

JavaScript / TypeScript

npm install @icebox/sdk

Python

pip install icebox-sdk

Ruby

gem install icebox

Go

go get github.com/icebox/sdk-go

Limites de Taxa

Os limites de taxa da API sao baseados no seu nivel de assinatura.

NivelLimite de TaxaLimite Diario
Gratis100 requisicoes/min1.000/dia
Pro1.000 requisicoes/min50.000/dia
Empresarial5.000 requisicoes/min250.000/dia
CorporativoPersonalizadoIlimitado

Autenticacao

Todas as requisicoes de API requerem autenticacao via chave de API ou token OAuth 2.0. Inclua suas credenciais no cabecalho Authorization.

Authorization: Bearer YOUR_API_KEY

Pronto para comecar?

Crie uma chave de API e comece a construir sua integracao hoje.