Referência da API
Crie integrações poderosas com a API do Icebox. Acesse emails, contatos e mais de forma programática.
Design RESTful
URLs limpas e previsíveis com métodos HTTP padrão
Seguro por Padrão
Opções de autenticação OAuth 2.0 e chave de API
Webhooks em Tempo Real
Receba notificações instantâneas quando eventos ocorrem
SDKs Oficiais
Bibliotecas para linguagens e frameworks populares
https://api.icebox.cool/v1Início Rápido
Comece a usar a API do Icebox em minutos.
// 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 -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
}
}Endpoints da API
Explore os endpoints disponíveis organizados por recurso.
E-mails
Envie, receba e gerencie mensagens de email
/emailsListar todos os emails/emails/{id}Obter um email especifico/emailsEnviar um novo email/emails/{id}Atualizar metadados do email/emails/{id}Excluir um emailContatos
Gerencie sua agenda de endereços e informações de contato
/contactsListar todos os contatos/contacts/{id}Obter um contato especifico/contactsCriar um novo contato/contacts/{id}Atualizar um contato/contacts/{id}Excluir um contatoPastas e Etiquetas
Organize emails com pastas e etiquetas
/foldersListar todas as pastas/foldersCriar uma nova pasta/labelsListar todas as etiquetas/labelsCriar uma nova etiquetaWebhooks
Receba notificações em tempo real para eventos
/webhooksListar inscrições de webhook/webhooksCriar um webhook/webhooks/{id}Excluir um webhookConta
Gerencie configurações e preferências da conta
/accountObter detalhes da conta/accountAtualizar configurações da conta/account/usageObter estatísticas de uso da APIAnexos
Faça upload e download de anexos de email
/attachments/{id}Baixar anexo/attachmentsEnviar anexo/attachments/{id}Excluir anexoSDKs Oficiais
Use nossas bibliotecas oficiais para integrar mais rápido.
JavaScript / TypeScript
npm install @icebox/sdkPython
pip install icebox-sdkRuby
gem install iceboxGo
go get github.com/icebox/sdk-goLimites de Taxa
Os limites de taxa da API são baseados no seu nível de assinatura.
Autenticação
Todas as requisições de API requerem autenticação via chave de API ou token OAuth 2.0. Inclua suas credenciais no cabeçalho Authorization.
Authorization: Bearer YOUR_API_KEYPronto para começar?
Crie uma chave de API e comece a construir sua integração hoje.