Source: https://once-email.com/es/api

Documentación para desarrolladores

Documentación para desarrolladores API

# API de Once Email

Documentación pública para pruebas automatizadas de correo: autenticación, cuotas, errores y uso seguro.

La documentación es pública. La creación de claves API y las llamadas reales aún no están abiertas al público. El flujo siguiente es solo para quienes ya tienen autorización explícita de acceso a la API y credenciales válidas.

Autenticación

Envía Authorization: Bearer oe\_live\_… en cada solicitud. La clave se muestra una vez; guárdala en un gestor de secretos, nunca en código del navegador, registros o Git.

```
Authorization: Bearer oe_live_your_key
```

Flujo para usuarios de prueba autorizados

1. Continúa solo con acceso a la API expresamente autorizado y credenciales válidas ya emitidas con los permisos mínimos necesarios. Guárdalas en un mecanismo de secretos del proceso; sin ese acceso, limítate a revisar documentación y descargas. Crea un buzón temporal y conserva su ID.
2. Haz que tu sistema de prueba envíe un correo a esa dirección.
3. Consulta la lista con espera progresiva; evita consultas vacías rápidas.
4. Lee el mensaje objetivo, completa las aserciones y elimina el buzón.

## Endpoints de Beta privada

` POST /v1/inboxes `` GET /v1/inboxes/{inboxId}/messages `` GET /v1/inboxes/{inboxId}/messages/{uid} `` GET /v1/inboxes/{inboxId}/messages/{uid}/attachments/{cid} `` DELETE /v1/inboxes/{inboxId} `

## Códigos de estado

` 400 `

Solicitud no válida

` 401 `

Clave ausente o no válida

` 403 `

Plan o recurso denegado

` 404 `

Recurso no encontrado

` 413 `

Respuesta o adjunto demasiado grande

` 429 `

Límite de frecuencia o cuota mensual

` 503 `

Fallo temporal del servicio

Disponibilidad de clientes

Hay candidatos preliminares de código abierto para TypeScript, Python, Java, Go, .NET, PHP y Ruby. La CI nativa pasó en Linux, macOS y Windows; aún no hay versiones de registro.

Estado de facturación

Developer usa suscripción mensual de Stripe y cuota API mensual. No se ofrece saldo recargable. El pago Live sigue cerrado hasta superar las pruebas de pago y reembolso.

Uso permitido

Usa la API solo en sistemas que estés autorizado a probar. Se prohíben spam, evasión de políticas, abuso de cuentas, vigilancia de comunicaciones ajenas y conservación prolongada de datos personales.

La API se prepara para producción

La documentación pública y las descargas preliminares no conceden acceso a la API. La creación de claves API y las llamadas reales no están abiertas al público.

[Ver SDK](<https://once-email.com/es/sdk>) Ver precios

API Demo

## Ejemplo seguro multiplataforma

Para sistemas propios o autorizados; funciona con Node.js 20+ en Windows, Linux y macOS.

```
node demos/api/authorized-workflow.mjs
ONCE_EMAIL_API_KEY <- process secret facility
create inbox -> list messages -> finally delete inbox
```

[Abrir demo completa](<https://github.com/pangxin12345/once-email-sdks/blob/main/demos/api/authorized-workflow.mjs>)

Guía de uso completa

## Descargar paquete local versionado

Úsalo solo con aplicaciones propias o autorizadas. Once Email solo recibe correo.

Documentación y código públicos; API controlada y descargas preliminares fuera de registros. La documentación pública y las descargas preliminares no conceden acceso a la API. La creación de claves API y las llamadas reales no están abiertas al público.

Verifica SHA256SUMS antes de extraer.

[Descargar paquete](<https://once-email.com/downloads/once-email-developer-demo-0.1.0-private.2.zip>) [SHA256SUMS](<https://once-email.com/downloads/SHA256SUMS>)

Punto de inicio local exacto

```
node demos/api/authorized-workflow.mjs
```

## De la descarga a la limpieza

1. Confirma propiedad o autorización; usa local, test o staging.
2. Continúa solo con acceso a la API expresamente autorizado y credenciales válidas ya emitidas con los permisos mínimos necesarios. Guárdalas en un mecanismo de secretos del proceso; sin ese acceso, limítate a revisar documentación y descargas.
3. Descarga, verifica, extrae y lee la documentación.
4. Ejecuta el demo con Node.js 20+ y activa un correo marcado.
5. Consulta con espera acotada y lee solo la coincidencia única.
6. Elimina el buzón en finally y separa el error de limpieza.

## Errores y recuperación

Distingue 400/401/403/404/413/429/503, tiempo agotado, ambigüedad, extracción, aserción y limpieza. Reintenta solo dentro de un plazo.

[Ver código público](<https://github.com/pangxin12345/once-email-sdks>) [Leer guía práctica](<https://once-email.com/es/blog/temporary-email-api-testing-guide>)
