Endpoints de la API: la lista completa

Todos los endpoints de la API de AtrioMail, uno por línea. Cada ruta empieza en la dirección de su panel de control, system.atriomail.com. Envíe su clave de API en el encabezado X-API-KEY en cada solicitud; cómo crear una clave, y el límite de 30 solicitudes por minuto, se explican en "Acceso a la API e integración".

Donde una ruta contiene {id}, ponga allí el número del dominio, buzón, reenvío, dirección catch-all, cuenta de cliente o trabajo de migración. Un endpoint de lista devuelve esos números.

Su cuenta

• GET /api/v1/user - La cuenta a la que pertenece la clave de API.
• GET /api/v1/status - Si la API y los servicios que la sostienen funcionan.
• GET /api/v1/dashboard - Cuántos dominios, buzones y trabajos de migración tiene.
• GET /api/v1/search - Busque dominios, buzones, alias y trabajos de migración por nombre. Envíe las palabras como q, con al menos 3 caracteres.

Dominios

• GET /api/v1/domains - Liste sus dominios, cada uno con su estado después de la verificación de seguridad.
• POST /api/v1/domains - Agregue un dominio.
• GET /api/v1/domains/{id} - Un dominio.
• PUT /api/v1/domains/{id} o PATCH /api/v1/domains/{id} - Cambie un dominio: su descripción, su propietario, sus límites de cantidad de buzones y de almacenamiento, y active para suspenderlo o reactivarlo.
• DELETE /api/v1/domains/{id} - Elimine un dominio.
• GET /api/v1/domains/{id}/ses-dns-records - Los registros DNS que el dominio necesita para enviar: la verificación de Amazon SES y DKIM.
• GET /api/v1/domains/{id}/ses-verification-status - Si esos registros de envío están verificados.
• GET /api/v1/domains/{id}/dns-propagation-status - Si los registros DNS del dominio ya se ven en internet.
• GET /api/v1/domains/{id}/mail-settings - La configuración IMAP y SMTP para entregar a los usuarios del dominio.
• POST /api/v1/domains/{id}/dns-check - Compruebe el DNS en vivo del dominio contra los registros exactos que necesita.

Comprobaciones de DNS

• POST /api/v1/dns-check - Compruebe el DNS de correo de un dominio por su nombre.
• GET /api/v1/dns-check/quota - Su asignación de comprobaciones de DNS y cuánto ha usado. Esta llamada no cuenta para la asignación.

Buzones

• GET /api/v1/mailboxes - Liste sus buzones.
• POST /api/v1/mailboxes - Cree un buzón.
• GET /api/v1/mailboxes/{id} - Un buzón.
• PUT /api/v1/mailboxes/{id} o PATCH /api/v1/mailboxes/{id} - Cambie un buzón: su nombre, su contraseña, su almacenamiento (quota, en MB), active para suspenderlo o reactivarlo, y revoke_sessions para cerrar además la sesión de todas las aplicaciones que lo usan.
• DELETE /api/v1/mailboxes/{id} - Elimine un buzón.
• POST /api/v1/mailboxes/{id}/revoke-access - Bloquee un buzón que otra persona puede estar usando: se suspende, se eliminan sus contraseñas de aplicación y se cierran sus conexiones abiertas. Envíe password para establecer una contraseña nueva al mismo tiempo.
• GET /api/v1/mailboxes/{id}/quota - El almacenamiento del buzón y cuánto ha usado.
• POST /api/v1/mailboxes/{id}/quota/increase - Dé más almacenamiento al buzón.
• POST /api/v1/mailboxes/{id}/quota/decrease - Dé menos almacenamiento al buzón.

Reenvíos

• GET /api/v1/forwarders - Liste sus reenvíos.
• POST /api/v1/forwarders - Cree un reenvío.
• GET /api/v1/forwarders/{id} - Un reenvío.
• PUT /api/v1/forwarders/{id} o PATCH /api/v1/forwarders/{id} - Cambie un reenvío.
• DELETE /api/v1/forwarders/{id} - Elimine un reenvío.

Direcciones catch-all

• GET /api/v1/catch-all - Liste sus direcciones catch-all.
• POST /api/v1/catch-all - Cree una dirección catch-all para un dominio.
• GET /api/v1/catch-all/{id} - Una dirección catch-all.
• PUT /api/v1/catch-all/{id} o PATCH /api/v1/catch-all/{id} - Cambie una dirección catch-all.
• DELETE /api/v1/catch-all/{id} - Elimine una dirección catch-all.

Cuentas de clientes

• GET /api/v1/users - Liste las cuentas de clientes que usted administra.
• POST /api/v1/users - Cree una cuenta de cliente. Si envía la misma solicitud otra vez, se devuelve la cuenta existente en lugar de un error.
• GET /api/v1/users/{id} - Una cuenta de cliente.
• PUT /api/v1/users/{id} o PATCH /api/v1/users/{id} - Cambie una cuenta de cliente.
• DELETE /api/v1/users/{id} - Elimine una cuenta de cliente.

Enlaces de inicio de sesión

• POST /api/v1/sso/token - Un enlace de un solo uso que lleva al cliente directamente a su panel de control con la sesión iniciada. Funciona una vez, durante 60 segundos.

Migraciones IMAP

• GET /api/v1/migrations - Liste sus trabajos de migración.
• POST /api/v1/migrations - Cree un trabajo de migración.
• GET /api/v1/migrations/stats - Cuántos trabajos de migración tiene, cuántos están activos y cuántos se están ejecutando.
• GET /api/v1/migrations/{id} - Un trabajo de migración y su progreso.
• PUT /api/v1/migrations/{id} o PATCH /api/v1/migrations/{id} - Cambie un trabajo de migración.
• DELETE /api/v1/migrations/{id} - Quite un trabajo de migración.
• POST /api/v1/migrations/{id}/toggle - Pause un trabajo de migración o reanude uno pausado.

Suspender y reactivar

No hay un endpoint de suspensión aparte. Un dominio o un buzón se desactiva y se vuelve a activar con active:

• Suspender un dominio: PATCH /api/v1/domains/{id} con "active": false. El dominio no admite buzones y su correo no se procesa hasta que se vuelva a activar.
• Reactivar un dominio: la misma solicitud con "active": true.
• Suspender un buzón: PATCH /api/v1/mailboxes/{id} con "active": false. El buzón no puede iniciar sesión, enviar ni recibir hasta que se vuelva a activar.
• Reactivar un buzón: la misma solicitud con "active": true.
• Bloquear en una sola llamada un buzón que otra persona puede estar usando: POST /api/v1/mailboxes/{id}/revoke-access. Suspende el buzón, salvo que envíe "suspend": false, que solo cierra la sesión de sus aplicaciones y, con password, cambia su contraseña.

PUT admite los mismos campos que PATCH. La activación de un dominio o un buzón se rechaza mientras el dominio sigue en su verificación de seguridad o en revisión, no fue aprobado o tiene el envío suspendido: un dominio responde 422 con el motivo en active, un buzón responde 409 con el motivo. En ese caso no se cambia nada, y el motivo indica qué ocurre después.

¿Necesita ayuda?

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