Crear una clave de API

Con una clave de API una aplicación envía directamente por la API REST de 2Mail, sin conexión SMTP, y recibe por mensaje un identificador para seguir el estado. Cree una clave propia por aplicación, para poder revocarlas por separado.

Paso 1: crear la clave

1. Abra en el panel de 2Mail el apartado de claves de API.
2. Cree una clave nueva y póngale el nombre de la aplicación que la va a usar: el nombre de su tienda online, de su CRM, de su programa de facturación. Nada de nombres genéricos como «producción»: dentro de un año nadie recordará para qué servía.
3. Elija a qué se aplica la clave: un solo buzón de envío (mailbox) o un grupo de buzones. La dirección de remitente de sus mensajes debe estar en uno de los dominios permitidos de ese buzón.
4. Guarde y copie la clave al momento. Por seguridad se muestra completa una sola vez; después solo verá el nombre y los primeros caracteres.

Paso 2: guardar la clave de forma segura

Ponga la clave en la configuración secreta de su aplicación —una variable de entorno o un gestor de secretos— y nunca en el código fuente, en un correo o en un mensaje de chat. Quien tenga la clave puede enviar en nombre de su dominio. Use una clave aparte para su entorno de pruebas y para el de producción; así una prueba nunca alcanza a sus clientes reales.

Paso 3: usar la clave

Su aplicación envía la clave en la cabecera de autorización de cada petición a la API. La documentación de la API de correo describe los extremos para enviar un mensaje, consultar el estado y gestionar webhooks. Cada petición que envía un mensaje devuelve un identificador; guárdelo junto al mensaje en su propio sistema, así podrá vincularle después el estado y los rebotes.

Paso 4: probar

Envíe un mensaje a una dirección de prueba externa y compruébelo en el registro de entrega del panel. En el apartado de claves de API, el panel muestra además la actividad reciente de la API por clave, algo práctico para ver qué aplicación hace qué.

Revocar o sustituir una clave

Si sospecha que una clave se ha filtrado, o si se marcha el desarrollador que la conocía, cree primero una clave nueva, póngala en la aplicación y solo después revoque la antigua. Así la aplicación no se para nunca. Una clave revocada deja de funcionar de inmediato; las peticiones con ella reciben un error como respuesta.

Dónde se tuerce

• Petición rechazada — la clave se ha copiado mal, está revocada o el dominio del remitente no pertenece al buzón de la clave.
• Clave perdida — no se puede volver a mostrar; cree una nueva.
• Una clave para todo — funciona, hasta que tiene que desactivar una aplicación. Sepárelas.

Si quiere recibir también las entregas, los rebotes y las aperturas en su aplicación, configure un webhook.

¿No lo consigue?

Indíquenos a través de contacto el nombre de la clave y la hora de su petición. Nunca la clave en sí: no necesitamos verla.