Acceso a la API e integración

AtrioMail cuenta con una API REST, de modo que su propio sistema de facturación, portal o herramienta de automatización puede administrar los objetos de correo sin que nadie tenga que iniciar sesión en el panel de control.

Cómo obtener una clave de API

1. Abra API Keys en el panel de control
2. Cree una clave
3. Copie la clave y guárdela en un lugar seguro

Datos importantes sobre las claves:

• La clave se muestra completa una sola vez, al crearla. Se almacena con hash, por lo que no se puede volver a mostrar.
• A una clave se le puede asignar una fecha de caducidad, y se puede desactivar o regenerar en cualquier momento.
• Una clave tiene todos los permisos de la cuenta que la creó. No existen claves de solo lectura ni con permisos limitados.
• Los intentos fallidos repetidos se bloquean temporalmente.

Cómo hacer una solicitud

Envíe su clave en el encabezado X-API-KEY por HTTPS.

La API admite hasta 30 solicitudes por minuto.

Qué abarca la API

• Dominios, incluido el estado de aprovisionamiento de cada dominio después de la verificación de seguridad automática (screening, revisión, listo o rechazado)
• Buzones y almacenamiento de los buzones
• Reenvíos y direcciones catch-all
• Cuentas de clientes, y dominios que pertenecen a esos clientes
• Trabajos de migración IMAP (crear, actualizar, pausar y eliminar)
• Comprobaciones de registros DNS de sus propios dominios, contra su clave DKIM exacta y sus registros de Amazon SES
• Enlaces de inicio de sesión de un solo uso que llevan al cliente directamente a su panel de control (válidos 60 segundos y de un solo uso). No se trata de SAML ni de OpenID Connect, y no inician sesión en el webmail.
• Los registros DNS que necesita un dominio (MX, SPF, verificación de Amazon SES y DKIM) y la configuración IMAP y SMTP para entregar a los usuarios finales

Los límites por dominio de cantidad de buzones y almacenamiento total se pueden establecer a través de la API. Las solicitudes que superan el límite se rechazan, y un límite no se puede reducir por debajo del uso actual.

Si vuelve a intentar la creación de un cliente, se devuelve la cuenta existente en lugar de un error.

Casos de uso comunes

• Crear un dominio y su primer buzón cuando un cliente hace un pedido en su propio sistema
• Crear cuentas para los clientes que usted administra
• Mostrar a un cliente sus registros DNS y la configuración del cliente de correo dentro de su propio portal
• Entregar a un cliente un enlace de inicio de sesión de un solo uso desde su portal
• Iniciar y seguir trabajos de migración IMAP

Si usa WHMCS, no necesita desarrollar nada de esto: descargue el módulo de aprovisionamiento desde la página Plugins del panel de control.

Cualquier herramienta de automatización capaz de enviar solicitudes HTTPS con un encabezado personalizado, como el nodo genérico HTTP Request de n8n, puede llamar a la API.

Cómo mantener segura su clave

• 🔒 Trate la clave como una contraseña: tiene los mismos permisos que la cuenta que la creó
• 🔒 Consérvela del lado del servidor, nunca en un navegador, una aplicación móvil o un repositorio público
• 🔒 Utilice solo HTTPS
• 🔒 Regenere o desactive la clave si cree que pudo quedar expuesta

¿Necesita ayuda?

Comuníquese con el soporte a través del chat en vivo del panel de control.