Tema
Documentacion para Desarrolladores

Referencia de API

Crea integraciones potentes con la API de Icebox. Accede a correos, contactos y mas de forma programatica.

Diseno RESTful

URLs limpias y predecibles con metodos HTTP estandar

Seguro por Defecto

Opciones de autenticacion OAuth 2.0 y clave API

Webhooks en Tiempo Real

Recibe notificaciones instantaneas cuando ocurren eventos

SDKs Oficiales

Bibliotecas para lenguajes y frameworks populares

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

Inicio Rapido

Comienza a usar la API de Icebox en 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);
Solicitud cURL
curl -X GET "https://api.icebox.cool/v1/emails" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Respuesta
{
  "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 de API

Explora los endpoints disponibles organizados por recurso.

Correos

Envia, recibe y gestiona mensajes de correo

GET/emailsListar todos los correos
GET/emails/{id}Obtener un correo especifico
POST/emailsEnviar un nuevo correo
PUT/emails/{id}Actualizar metadatos del correo
DELETE/emails/{id}Eliminar un correo

Contactos

Gestiona tu libreta de direcciones e informacion de contacto

GET/contactsListar todos los contactos
GET/contacts/{id}Obtener un contacto especifico
POST/contactsCrear un nuevo contacto
PUT/contacts/{id}Actualizar un contacto
DELETE/contacts/{id}Eliminar un contacto

Carpetas y Etiquetas

Organiza correos con carpetas y etiquetas

GET/foldersListar todas las carpetas
POST/foldersCrear una nueva carpeta
GET/labelsListar todas las etiquetas
POST/labelsCrear una nueva etiqueta

Webhooks

Recibe notificaciones en tiempo real de eventos

GET/webhooksListar suscripciones de webhook
POST/webhooksCrear un webhook
DELETE/webhooks/{id}Eliminar un webhook

Cuenta

Gestiona configuracion y preferencias de cuenta

GET/accountObtener detalles de cuenta
PUT/accountActualizar configuracion de cuenta
GET/account/usageObtener estadisticas de uso de API

Adjuntos

Sube y descarga adjuntos de correo

GET/attachments/{id}Descargar adjunto
POST/attachmentsSubir adjunto
DELETE/attachments/{id}Eliminar adjunto

SDKs Oficiales

Usa nuestras bibliotecas oficiales para integrar mas 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 Tasa

Los limites de tasa de API se basan en tu nivel de suscripcion.

NivelLimite de TasaLimite Diario
Gratis100 solicitudes/min1,000/dia
Pro1,000 solicitudes/min50,000/dia
Empresas5,000 solicitudes/min250,000/dia
CorporativoPersonalizadoIlimitado

Autenticacion

Todas las solicitudes de API requieren autenticacion via clave API o token OAuth 2.0. Incluye tus credenciales en el encabezado Authorization.

Authorization: Bearer YOUR_API_KEY

Listo para comenzar?

Crea una clave API y comienza a construir tu integracion hoy.