CountdownMail API

Szybki start

Ta sekcja przygotuje Cie do korzystania z API CountdownMail i pokaze, jak wykonac pierwsze zapytanie API.

1. Pobierz swoj klucz API:
   • Zaloguj sie na swoje konto CountdownMail.
   • Przejdz do Profil » API.
   • Skopiuj swoj klucz API.
2. Wykonaj swoje pierwsze zapytanie API:
   • Uzyj endpoint "Utworz licznik" jako przyklad.
   • Uzyj narzedzia takiego jak cURL lub Postman, aby wyslac zapytanie POST do https://countdownmail.com/api/create.
   • Dodaj swoj klucz API w naglowku Authorization.
   • Dolacz wymagane szczegoly licznika w tresci zapytania (w formacie JSON).

Oto przyklad z uzyciem 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"
}'
                                    

• Zastap YOUR_API_KEY swoim prawdziwym kluczem API.
• Jesli wszystko dziala, otrzymasz odpowiedz taka jak ta:

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

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

Uwierzytelnianie

Aby korzystac z API CountdownMail, musisz uwierzytelnic kazde zapytanie swoim kluczem API. Oto jak to zrobic:

• Dodaj naglowek Authorization do swojego zapytania. Wartosc to Twoj klucz API.
• Alternatywnie uzyj uwierzytelniania podstawowego: ustaw klucz API jako nazwe uzytkownika i pozostaw haslo puste.

Przyklad z naglowkiem Authorization (cURL):

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

• Zastap YOUR_API_KEY swoim prawdziwym kluczem API.
• Zawsze dolaczaj uwierzytelnianie, w przeciwnym razie otrzymasz blad 401 Unauthorized.

Uzywanie Postman

Jesli uzywasz Postman, ulatwia to testowanie zapytan API. Aby uzyc go z CountdownMail:

• Kliknij, aby zaimportowac kolekcje API CountdownMail.
• Dodaj swoj klucz API do ustawien uwierzytelniania kolekcji i mozesz zaczac wysylac zapytania.

Bledy

Czasami zapytania API koncza sie niepowodzeniem. API CountdownMail uzywa kodow statusu HTTP, aby poinformowac co poszlo nie tak. Oto lista mozliwych bledow, ich znaczenie i co robic:

Przyklad odpowiedzi bledu (401 Unauthorized):

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

Jesli widzisz blad, sprawdz kod statusu i komunikat, a nastepnie postepuj zgodnie z sugerowanym dzialaniem.

Model licznika

Zasob Timer zawiera wszystkie informacje o liczniku odliczania. Oto pola dostepne do definiowania licznika odliczania:

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

Utworz licznik

Ten endpoint pozwala utworzyc licznik. Aby utworzyc nowy licznik, musisz podac wszystkie wymagane wlasciwosci.

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

Zaktualizuj licznik

Ten endpoint pozwala zaktualizowac dowolny atrybut licznika. Aby zaktualizowac licznik, wyslij zapytanie PUT do /update/{code} z polami do aktualizacji. Zastap {code} kodem licznika (np. "td").

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

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

Zduplikuj licznik

Aby skopiowac istniejacy licznik, wyslij zapytanie POST do /duplicate/{code}. Zastap {code} unikalnym kodem licznika do skopiowania. Tworzy to nowy licznik z tymi samymi ustawieniami co oryginal.

Mozesz zaktualizowac szczegoly nowego licznika dodajac obiekt JSON w tresci zapytania. Pozwala to zmienic okreslone atrybuty, jak czas zakonczenia lub nazwe, zachowujac pozostale ustawienia z oryginalu. Atrybuty do aktualizacji sa takie same jak przy tworzeniu nowego licznika (pelna lista w sekcji Model licznika). Jesli nie dolaczysz atrybutu, pozostanie taki sam jak w oryginalnym liczniku.

Wazne: Oryginalny licznik sie nie zmienia. Tylko nowy licznik jest modyfikowany przez aktualizacje wyslane w zapytaniu.

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

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

Dezaktywuj licznik

Aby zatrzymac licznik (zarchiwizowac), wyslij zapytanie GET do /deactivate/{code}. Zastap {code} kodem licznika.

Aktywuj licznik

Aby ponownie aktywowac licznik, wyslij zapytanie GET do /activate/{code}. Zastap {code} kodem licznika.

Usun licznik

Aby usunac licznik, wyslij zapytanie DELETE do /delete/{code}. Zastap {code} kodem licznika.