CountdownMail API

Schnellstart

Dieser Abschnitt bereitet Sie auf die Nutzung der CountdownMail API vor und zeigt Ihnen, wie Sie Ihre erste API-Anfrage stellen.

1. Holen Sie sich Ihren API-Schlüssel:
   • Melden Sie sich bei Ihrem CountdownMail-Konto an.
   • Gehen Sie zu Profil » API.
   • Kopieren Sie Ihren API-Schlüssel.
2. Stellen Sie Ihre erste API-Anfrage:
   • Wir verwenden den "Timer erstellen"-Endpunkt als Beispiel.
   • Verwenden Sie ein Tool wie cURL oder Postman, um eine POST-Anfrage an https://countdownmail.com/api/create zu senden.
   • Fügen Sie Ihren API-Schlüssel im Authorization-Header hinzu.
   • Fügen Sie die erforderlichen Timer-Details im Anfragekörper hinzu (im JSON-Format).

Hier ist ein Beispiel mit 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"
}'
                                    

• Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel.
• Wenn alles funktioniert, erhalten Sie eine Antwort wie diese:

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

Diese Antwort enthält einen Timer-Code (z.B. "td") und eine URL für das Timer-Bild.

Authentifizierung

Um die CountdownMail API zu nutzen, müssen Sie jede Anfrage mit Ihrem API-Schlüssel authentifizieren. So geht's:

• Fügen Sie Ihrer Anfrage einen Authorization-Header hinzu. Der Wert ist Ihr API-Schlüssel.
• Alternativ können Sie Basic-Authentifizierung verwenden: Setzen Sie Ihren API-Schlüssel als Benutzernamen und lassen Sie das Passwort leer.

Beispiel mit Authorization-Header (cURL):

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

• Ersetzen Sie YOUR_API_KEY durch Ihren tatsächlichen API-Schlüssel.
• Authentifizieren Sie immer, sonst erhalten Sie einen 401 Unauthorized-Fehler.

Postman verwenden

Wenn Sie Postman verwenden, erleichtert es das Testen von API-Anfragen. So verwenden Sie es mit CountdownMail:

• Klicken Sie, um die CountdownMail API-Sammlung zu importieren.
• Fügen Sie Ihren API-Schlüssel zu den Authentifizierungseinstellungen der Sammlung hinzu, und Sie können mit Anfragen beginnen.

Fehler

Manchmal schlagen API-Anfragen fehl. Die CountdownMail API verwendet HTTP-Statuscodes, um Ihnen mitzuteilen, was schief gelaufen ist. Hier ist eine Liste möglicher Fehler, ihre Bedeutung und was zu tun ist:

Beispiel-Fehlerantwort (401 Unauthorized):

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

Wenn Sie einen Fehler sehen, überprüfen Sie den Statuscode und die Nachricht und befolgen Sie dann die empfohlene Maßnahme.

Timer-Modell

Die Timer-Ressource enthält alle Informationen über den Countdown-Timer. Dies sind die verfügbaren Felder zum Definieren eines Countdown-Timers:

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

Timer erstellen

Dieser Endpunkt ermöglicht das Erstellen eines Timers. Um einen neuen Timer zu erstellen, müssen Sie alle erforderlichen Eigenschaften angeben.

Beispielanfrage:

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

Timer aktualisieren

Dieser Endpunkt ermöglicht das Aktualisieren beliebiger Timer-Attribute. Um einen Timer zu aktualisieren, senden Sie eine PUT-Anfrage an /update/{code} mit den Feldern, die Sie aktualisieren möchten. Ersetzen Sie {code} durch den Timer-Code (z.B. "td").

Beispielanfrage:

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

Timer duplizieren

Um eine Kopie eines vorhandenen Timers zu erstellen, senden Sie eine POST-Anfrage an /duplicate/{code}. Ersetzen Sie {code} durch den eindeutigen Code des Timers, den Sie kopieren möchten. Dies erstellt einen neuen Timer mit denselben Einstellungen wie das Original.

Sie können Details des neuen Timers aktualisieren, indem Sie ein JSON-Objekt im Anfragekörper hinzufügen. So können Sie bestimmte Attribute ändern, wie die Endzeit oder den Namen, während alles andere wie im Original bleibt. Die Attribute, die Sie aktualisieren können, sind dieselben, die Sie beim Erstellen eines neuen Timers festlegen können (siehe den Abschnitt Timer-Modell für die vollständige Liste). Wenn Sie ein Attribut nicht angeben, bleibt es wie im ursprünglichen Timer.

Wichtig: Der ursprüngliche Timer ändert sich nicht. Nur der neue Timer wird von den Aktualisierungen betroffen, die Sie in der Anfrage senden.

Beispielanfrage:

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

Timer deaktivieren

Um einen Timer zu stoppen (archivieren), senden Sie eine GET-Anfrage an /deactivate/{code}. Ersetzen Sie {code} durch den Timer-Code.

Timer aktivieren

Um einen Timer wieder zu aktivieren, senden Sie eine GET-Anfrage an /activate/{code}. Ersetzen Sie {code} durch den Timer-Code.

Timer löschen

Um einen Timer zu löschen, senden Sie eine DELETE-Anfrage an /delete/{code}. Ersetzen Sie {code} durch den Timer-Code.