CountdownMail API

Быстрый старт

Этот раздел подготовит вас к использованию API CountdownMail и покажет, как сделать первый API-запрос.

1. Получите свой API-ключ:
   • Войдите в свою учётную запись CountdownMail.
   • Перейдите в Профиль » API.
   • Скопируйте свой API-ключ.
2. Сделайте первый API-запрос:
   • Мы используем эндпоинт «Создать таймер» в качестве примера.
   • Используйте инструмент вроде cURL или Postman для отправки POST-запроса на https://countdownmail.com/api/create.
   • Добавьте свой API-ключ в заголовок Authorization.
   • Включите необходимые данные таймера в тело запроса (в формате JSON).

Вот пример с использованием 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"
}'
                                    

• Замените YOUR_API_KEY на ваш настоящий API-ключ.
• Если всё работает, вы получите ответ вроде:

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

Этот ответ включает код таймера (например, "td") и URL изображения таймера.

Аутентификация

Для использования API CountdownMail необходимо аутентифицировать каждый запрос с помощью API-ключа. Вот как:

• Добавьте заголовок Authorization к запросу. Значение — ваш API-ключ.
• Альтернативно используйте базовую аутентификацию: установите API-ключ как имя пользователя и оставьте пароль пустым.

Пример с заголовком Authorization (cURL):

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

• Замените YOUR_API_KEY на ваш настоящий API-ключ.
• Всегда включайте аутентификацию, иначе получите ошибку 401 Unauthorized.

Использование Postman

Если вы используете Postman, это упрощает тестирование API-запросов. Чтобы использовать его с CountdownMail:

• Нажмите, чтобы импортировать коллекцию API CountdownMail.
• Добавьте API-ключ в настройки аутентификации коллекции, и вы готовы отправлять запросы.

Ошибки

Иногда API-запросы не удаются. API CountdownMail использует коды состояния HTTP, чтобы сообщить о проблеме. Вот список возможных ошибок, их значение и что делать:

Пример ответа с ошибкой (401 Unauthorized):

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

Если видите ошибку, проверьте код статуса и сообщение, затем выполните рекомендуемое действие.

Модель таймера

Ресурс Timer содержит всю информацию о таймере обратного отсчёта. Вот доступные поля для определения таймера:

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

Создать таймер

Этот эндпоинт позволяет создать таймер. Для создания нового таймера необходимо указать все обязательные свойства.

Пример запроса:

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-02-02 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"
    }
}
                                    

Обновить таймер

Этот эндпоинт позволяет обновить любой атрибут таймера. Для обновления таймера отправьте PUT-запрос на /update/{code} с полями для обновления. Замените {code} на код таймера (напр., "td").

Пример запроса:

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-02-02 20:00:00"
}'
                                    

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

Дублировать таймер

Чтобы скопировать существующий таймер, отправьте POST-запрос на /duplicate/{code}. Замените {code} на уникальный код таймера для копирования. Это создаст новый таймер с теми же настройками, что и оригинал.

Вы можете обновить детали нового таймера, добавив JSON-объект в тело запроса. Это позволяет изменять определённые атрибуты, такие как время окончания или название, сохраняя остальное как в оригинале. Атрибуты для обновления те же, что и при создании нового таймера (полный список в разделе Модель таймера). Если атрибут не указан, он остаётся как в оригинальном таймере.

Важно: Оригинальный таймер не изменяется. Только новый таймер получает обновления из запроса.

Пример запроса:

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-02-02 20:00:00"
}'
                                    

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

Деактивировать таймер

Чтобы остановить таймер (архивировать), отправьте GET-запрос на /deactivate/{code}. Замените {code} на код таймера.

Активировать таймер

Чтобы снова активировать таймер, отправьте GET-запрос на /activate/{code}. Замените {code} на код таймера.

Удалить таймер

Чтобы удалить таймер, отправьте DELETE-запрос на /delete/{code}. Замените {code} на код таймера.