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} на код таймера.