Saltar al contenido principal

Introducción a la API

Bienvenido a la API de SendDock. Puedes usar nuestra API para enviar correos electrónicos transaccionales y administrar suscriptores.

URL Base

Todas las solicitudes deben hacerse a:

https://senddock.dev/api/v1
Soporte CORS

Soportamos CORS para uso en frontend (usando Claves Públicas).

Formato de Respuesta

Usamos JSON estándar para todas las respuestas.

{
"success": true,
"data": { ... }
}

Autenticación

Usamos autenticación Bearer Token. Tienes dos tipos de claves:

  • Clave Pública (pk_...): Segura para uso del lado del cliente (navegadores, aplicaciones móviles). Solo para agregar suscriptores.
  • Clave Secreta (sdk_...): ¡Mantenla en secreto! Solo para uso del lado del servidor. Acceso completo para enviar correos y broadcasts.

¿Cómo funcionan las claves de API?

  1. Genera una clave de API desde el panel de SendDock (Configuración → Claves API).
  2. Guárdala en tu .env. Nunca la publiques en el frontend.
  3. Envía la clave de API en el encabezado de cada solicitud:
Authorization: Bearer sdk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Límites de Tasa

SendDock usa Redis para controlar el tráfico y proteger la reputación de envío.

EndpointLímite BaseNotas
POST /api/v1/send60 req/minEnvíos transaccionales rápidos.
POST /api/v1/join60 req/minRegistros de usuarios.
POST /api/v1/broadcast10 req/minCola de campañas masivas.
GET endpoints60 req/minConsultas de lectura.
nota

Los planes Pro y Protocol pueden tener límites configurados más altos.

Códigos de Error

CódigoSignificadoCausa
400Solicitud IncorrectaCampos faltantes (email, template) o formato inválido.
401No AutorizadoClave de API faltante o inválida. Verifica tu token Bearer.
403ProhibidoUsando Clave Pública para un endpoint protegido (como /send).
404No EncontradoProyecto o Plantilla no encontrada.
429Límite de TasaDemasiadas solicitudes. Ver límites arriba.
500Error del ServidorError interno o fallo de conexión SMTP.