Primeros pasos con la API REST de SynerMail

Obtén tu token

Abre el perfil o los ajustes de la cuenta y busca API Token o Developer / API. Guarda el token en un almacén de secretos y usa un token limitado a la cuenta del cliente para sus integraciones.

Haz una solicitud de solo lectura

Confirma la ruta base, la autenticación y los recursos de tu versión. El ejemplo usa /api/v1/lists y autenticación Bearer. Verifica las rutas en tu instalación.

curl -fsS "https://mail.example.com/api/v1/lists" \
  -H "Authorization: Bearer $SYNERMAIL_TOKEN" \
  -H "Accept: application/json"

Usa el UID de la lista en las solicitudes siguientes. Evita poner credenciales en las URL o en código que se ejecute en el navegador.

Usa los mismos encabezados en tu integración

• PHP: configura Guzzle con la URL base y los encabezados y llama a get.
• Python: usa requests.get con encabezados y tiempo de espera, seguido de raise_for_status.
• Node.js: usa fetch y verifica response.ok antes de leer el JSON.
• Go: usa net/http con tiempo de espera y comprueba los errores y el estado antes de decodificar el JSON.

Resuelve errores

• 401 o 403: verifica el token, los permisos y el alcance de la cuenta.
• 404: confirma la URL base y si existe la ruta.
• 415: indica el Content-Type del cuerpo de la solicitud.
• 422: revisa la respuesta de validación.
• 429: respeta Retry-After si está presente y limita los reintentos.
• 500: consulta los registros con tu administrador.
• Error de certificado: corrige la cadena de confianza o configura la CA del entorno de pruebas.

Limita el acceso

Confirma los permisos, la rotación de tokens, los límites de solicitudes y la disponibilidad de un endpoint de inicio de sesión. Haz las llamadas con tokens privados desde tu servidor. Para sincronizar archivos CSV, consulta Gestión de listas.