CountdownMail API

Inicio rápido

Esta sección te preparará para usar la API de CountdownMail y te mostrará cómo hacer tu primera solicitud API.

1. Obtén tu clave API:
   • Inicia sesión en tu cuenta de CountdownMail.
   • Ve a Perfil » API.
   • Copia tu clave API.
2. Haz tu primera solicitud API:
   • Usaremos el endpoint "Crear un temporizador" como ejemplo.
   • Usa una herramienta como cURL o Postman para enviar una solicitud POST a https://countdownmail.com/api/create.
   • Agrega tu clave API en el encabezado Authorization.
   • Incluye los detalles requeridos del temporizador en el cuerpo de la solicitud (en formato JSON).

Aquí hay un ejemplo usando cURL:

curl -H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-X POST "https://countdownmail.com/api/create" \
-d '{
    "skin_id": 1,
    "name": "Big Sale!",
    "time_end": "2025-04-21 20:00:00",
    "time_zone": "America/Los_Angeles",
    "font_family": "Roboto-Bold",
    "color_primary": "FF3A43",
    "color_text": "FFFFFF",
    "color_bg": "000000"
}'
                                    

• Reemplaza YOUR_API_KEY con tu clave API real.
• Si todo funciona, obtendrás una respuesta como esta:

{
    "status": "success",
    "message": {
        "id": 1057,
        "code": "td",
        "src": "http://i.countdownmail.com/td.gif"
    }
}
                                    

Esta respuesta incluye un código de temporizador (ej., "td") y una URL para la imagen del temporizador.

Autenticación

Para usar la API de CountdownMail, necesitas autenticar cada solicitud con tu clave API. Así es como:

• Agrega un encabezado Authorization a tu solicitud. El valor es tu clave API.
• Alternativamente, usa autenticación básica: establece tu clave API como nombre de usuario y deja la contraseña vacía.

Ejemplo con encabezado Authorization (cURL):

curl -H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-X GET "https://countdownmail.com/api/some_endpoint"
                                    

• Reemplaza YOUR_API_KEY con tu clave API real.
• Siempre incluye autenticación, o recibirás un error 401 Unauthorized.

Usar Postman

Si usas Postman, es fácil probar las solicitudes a la API. Para usarlo con CountdownMail:

• Haz clic para importar la colección de API de CountdownMail.
• Agrega tu clave API a la configuración de autenticación de la colección y estarás listo para comenzar a hacer solicitudes.

Errores

A veces, las solicitudes API fallan. La API de CountdownMail usa códigos de estado HTTP para indicarte qué salió mal. Aquí hay una lista de posibles errores, su significado y qué hacer:

Ejemplo de respuesta de error (401 Unauthorized):

{
    "status": "error",
    "message": "Unauthorized"
}
                                    

Si ves un error, verifica el código de estado y el mensaje, luego sigue la acción sugerida.

Modelo del temporizador

El recurso Timer contiene toda la información sobre el temporizador de cuenta regresiva. Estos son los campos disponibles para definir un temporizador de cuenta regresiva:

{
    "separator_color"  : "4275BC",
    "separator_size" : 1.3,
    "separator_style" : 6,
    "labels_color" : "A3A3A3"
}
                                    

Crear un temporizador

Este endpoint te permite crear un temporizador. Para crear un nuevo temporizador, debes proporcionar todas las propiedades requeridas.

Ejemplo de solicitud:

curl -H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-X POST "https://countdownmail.com/api/create" \
-d '{
    "skin_id":3,
    "name":"Big Sale!",
    "time_end":"2026-10-05 20:00:00",
    "time_zone":"America\/Los_Angeles",
    "font_family":"Roboto-Bold",
    "color_primary":"FF3A43",
    "color_text":"FFFFFF",
    "color_bg":"000000",
    "transparent":"0",
    "font_size":"38",
    "lang":"en",
    "expired_mes_on":"1",
    "expired_mes":"This offer has expired",
    "labels":"1",
    "days":"days",
    "hours":"hours",
    "minutes":"minutes",
    "seconds":"seconds"
}'
                                    

{
    "status": "success",
    "message": {
        "id": 1057,
        "code": "td",
        "src": "http://i.countdownmail.com/td.gif"
    }
}
                                    

Actualizar un temporizador

Este endpoint te permite actualizar cualquier atributo del temporizador. Para actualizar un temporizador, envía una solicitud PUT a /update/{code} con los campos que deseas actualizar. Reemplaza {code} con el código del temporizador (ej., "td").

Ejemplo de solicitud:

curl -H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-X PUT "https://countdownmail.com/api/update/{code}" \
-d '{
    "skin_id":6,
    "name":"Flash Sale!",
    "time_end":"2026-10-05 20:00:00"
}'
                                    

{
    "status": "success",
    "message": {
        "id": 1057,
        "code": "td",
        "src": "http://i.countdownmail.com/td.gif"
    }
}
                                    

Duplicar un temporizador

Para hacer una copia de un temporizador existente, envía una solicitud POST a /duplicate/{code}. Reemplaza {code} con el código único del temporizador que deseas copiar. Esto crea un nuevo temporizador que comienza con la misma configuración que el original.

Puedes actualizar los detalles del nuevo temporizador agregando un objeto JSON en el cuerpo de la solicitud. Esto te permite cambiar atributos específicos, como la hora de finalización o el nombre, mientras mantienes todo lo demás igual que el original. Los atributos que puedes actualizar son los mismos que puedes establecer al crear un nuevo temporizador (consulta la sección Modelo del temporizador para la lista completa). Si no incluyes un atributo, permanece igual que en el temporizador original.

Importante: El temporizador original no cambia. Solo el nuevo temporizador se ve afectado por las actualizaciones que envías en la solicitud.

Ejemplo de solicitud:

curl -H "Content-Type: application/json" \
-H "Authorization: YOUR_API_KEY" \
-X POST "https://countdownmail.com/api/duplicate/{code}" \
-d '{
    "skin_id":6,
    "name":"Flash Sale!",
    "time_end":"2026-10-05 20:00:00"
}'
                                    

{
    "status": "success",
    "message": {
        "id": 1057,
        "code": "td",
        "src": "http://i.countdownmail.com/td.gif"
    }
}
                                    

Desactivar un temporizador

Para detener un temporizador (archivar), envía una solicitud GET a /deactivate/{code}. Reemplaza {code} con el código del temporizador.

Activar un temporizador

Para activar un temporizador de nuevo, envía una solicitud GET a /activate/{code}. Reemplaza {code} con el código del temporizador.

Eliminar un temporizador

Para eliminar un temporizador, envía una solicitud DELETE a /delete/{code}. Reemplaza {code} con el código del temporizador.