CountdownMail API

Szybki start

Ta sekcja przygotuje Cię do korzystania z API CountdownMail i pokaże, jak wykonać pierwsze zapytanie API.

1. Pobierz swój klucz API:
   • Zaloguj się na swoje konto CountdownMail.
   • Przejdź do Profil » API.
   • Skopiuj swój klucz API.
2. Wykonaj swoje pierwsze zapytanie API:
   • Jako przykładu użyjemy endpointu "Utwórz licznik".
   • Użyj narzędzia takiego jak cURL lub Postman, aby wysłać zapytanie POST do https://countdownmail.com/api/create.
   • Dodaj swój klucz API w nagłówku Authorization.
   • Dołącz wymagane szczegóły licznika w treści zapytania (w formacie JSON).

Oto przykład z użyciem 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"
}'
                                    

• Zastąp YOUR_API_KEY swoim prawdziwym kluczem API.
• Jeśli wszystko działa, otrzymasz odpowiedź taką jak ta:

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

Ta odpowiedź zawiera kod licznika (np. "td") i URL obrazu licznika.

Uwierzytelnianie

Aby korzystać z API CountdownMail, musisz uwierzytelnić każde zapytanie swoim kluczem API. Oto jak to zrobić:

• Dodaj nagłówek Authorization do swojego zapytania. Wartość to Twój klucz API.
• Alternatywnie użyj uwierzytelniania podstawowego: ustaw klucz API jako nazwę użytkownika i pozostaw hasło puste.

Przykład z nagłówkiem Authorization (cURL):

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

• Zastąp YOUR_API_KEY swoim prawdziwym kluczem API.
• Zawsze dołączaj uwierzytelnianie, w przeciwnym razie otrzymasz błąd 401 Unauthorized.

Korzystanie z Postmana

Jeśli używasz Postman, ułatwia to testowanie zapytań API. Aby użyć go z CountdownMail:

• Kliknij, aby zaimportować kolekcję API CountdownMail.
• Dodaj swój klucz API do ustawień uwierzytelniania kolekcji i możesz zacząć wysyłać zapytania.

Błędy

Czasami zapytania API kończą się niepowodzeniem. API CountdownMail używa kodów statusu HTTP, aby poinformować, co poszło nie tak. Oto lista możliwych błędów, ich znaczenie oraz zalecane działania:

Przykład odpowiedzi błędu (401 Unauthorized):

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

Jeśli widzisz błąd, sprawdź kod statusu i komunikat, a następnie postępuj zgodnie z sugerowanym działaniem.

Model licznika

Zasób Timer zawiera wszystkie informacje o liczniku odliczania. Oto pola dostępne do definiowania licznika odliczania:

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

Utwórz licznik

Ten endpoint pozwala utworzyć licznik. Aby utworzyć nowy licznik, musisz podać wszystkie wymagane właściwości.

Przykład zapytania:

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

Zaktualizuj licznik

Ten endpoint pozwala zaktualizować dowolny atrybut licznika. Aby zaktualizować licznik, wyślij zapytanie PUT do /update/{code} z polami do aktualizacji. Zastąp {code} kodem licznika (np. "td").

Przykład zapytania:

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

Zduplikuj licznik

Aby skopiować istniejący licznik, wyślij zapytanie POST do /duplicate/{code}. Zastąp {code} unikalnym kodem licznika do skopiowania. Tworzy to nowy licznik z tymi samymi ustawieniami co oryginał.

Możesz zaktualizować szczegóły nowego licznika, dodając obiekt JSON w treści zapytania. Pozwala to zmienić określone atrybuty, jak czas zakończenia lub nazwę, zachowując pozostałe ustawienia z oryginału. Atrybuty do aktualizacji są takie same jak przy tworzeniu nowego licznika (pełna lista w sekcji Model licznika). Jeśli nie dołączysz atrybutu, pozostanie taki sam jak w oryginalnym liczniku.

Ważne: Oryginalny licznik się nie zmienia. Tylko nowy licznik jest modyfikowany przez aktualizacje wysłane w zapytaniu.

Przykład zapytania:

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

Dezaktywuj licznik

Aby zatrzymać licznik (zarchiwizować), wyślij zapytanie GET do /deactivate/{code}. Zastąp {code} kodem licznika.

Aktywuj licznik

Aby ponownie aktywować licznik, wyślij zapytanie GET do /activate/{code}. Zastąp {code} kodem licznika.

Usuń licznik

Aby usunąć licznik, wyślij zapytanie DELETE do /delete/{code}. Zastąp {code} kodem licznika.