Ir a la documentación
API

Inicio rápido

Una clave y un primer envío.

1. Crea una clave

  1. Abre Configuración → Claves de API. La página solo está ahí si eres el propietario del buzón.
  2. Ponle el nombre de aquello que vaya a usarla. Ese nombre es como la vuelves a encontrar cuando haya que revocar algo.
  3. Elige sus scopes. Solo envío, de forma predeterminada.
  4. Opcionalmente, acota como qué puede enviar: dominios completos, direcciones sueltas o ambos. Un dominio completo cubre las direcciones que se le añadan después.
  5. Copia la clave. Se muestra una sola vez y no se puede recuperar: lo que se almacena es un hash de un solo sentido. Rotar la clave más adelante muestra la sustituta una sola vez, del mismo modo.

2. Envía algo

npm install @openemail/sdk

Opcional. Todos los endpoints son HTTP y JSON sin más, y la pestaña de curl de abajo no requiere instalar nada.

curl -X POST https://api.openemail.uk/emails \  -H "Authorization: Bearer $OPENEMAIL_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "from": "Acme Billing <[email protected]>",    "to": ["[email protected]"],    "subject": "Your September invoice",    "html": "<p>Invoice attached.</p>"  }'

Un 200 significa que ya salió. Recibes un id. Consérvalo: es como recuperas el mensaje, lees su rastro de eventos o lo cancelas si lo programaste.

¿Recibes un 403 que no esperabas? GET /addresses enumera exactamente como qué puede enviar esta clave. Casi siempre es el scope de envío de la clave, un dominio o una dirección que no se le concedió, y no un dominio que falte en el espacio de trabajo.