CountdownMail API

Snelstart

Dit gedeelte bereidt u voor op het gebruik van de CountdownMail API en laat zien hoe u uw eerste API-verzoek doet.

1. Verkrijg uw API-sleutel:
   • Log in op uw CountdownMail-account.
   • Ga naar Profiel » API.
   • Kopieer uw API-sleutel.
2. Doe uw eerste API-verzoek:
   • We gebruiken het "Timer maken"-endpoint als voorbeeld.
   • Gebruik een tool zoals cURL of Postman om een POST-verzoek naar https://countdownmail.com/api/create te sturen.
   • Voeg uw API-sleutel toe in de Authorization-header.
   • Voeg de vereiste timerdetails toe in de request body (in JSON-formaat).

Hier is een voorbeeld met 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"
}'
                                    

• Vervang YOUR_API_KEY door uw werkelijke API-sleutel.
• Als alles werkt, krijgt u een respons zoals dit:

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

Deze respons bevat een timercode (bijv. "td") en een URL voor de timer-afbeelding.

Authenticatie

Om de CountdownMail API te gebruiken, moet u elk verzoek authenticeren met uw API-sleutel. Zo werkt het:

• Voeg een Authorization-header toe aan uw verzoek. De waarde is uw API-sleutel.
• U kunt ook basisauthenticatie gebruiken: stel uw API-sleutel in als gebruikersnaam en laat het wachtwoord leeg.

Voorbeeld met Authorization-header (cURL):

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

• Vervang YOUR_API_KEY door uw werkelijke API-sleutel.
• Voeg altijd authenticatie toe, anders krijgt u een 401 Unauthorized-fout.

Postman gebruiken

Als u Postman gebruikt, maakt het het testen van API-verzoeken gemakkelijk. Om het te gebruiken met CountdownMail:

• Klik om de CountdownMail API-collectie te importeren.
• Voeg uw API-sleutel toe aan de authenticatie-instellingen van de collectie en u kunt beginnen met het doen van verzoeken.

Fouten

Soms mislukken API-verzoeken. De CountdownMail API gebruikt HTTP-statuscodes om aan te geven wat er mis is gegaan. Hier is een lijst met mogelijke fouten, hun betekenis en wat te doen:

Voorbeeld foutrespons (401 Unauthorized):

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

Als u een fout ziet, controleer de statuscode en het bericht en volg dan de aanbevolen actie.

Timer-model

De Timer-resource bevat alle informatie over de countdown-timer. Dit zijn de beschikbare velden voor het definiëren van een countdown-timer:

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

Timer maken

Dit endpoint stelt u in staat een timer te maken. Om een nieuwe timer te maken, moet u alle vereiste eigenschappen opgeven.

Voorbeeldverzoek:

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 bijwerken

Dit endpoint stelt u in staat elk timerattribuut bij te werken. Om een timer bij te werken, stuurt u een PUT-verzoek naar /update/{code} met de velden die u wilt bijwerken. Vervang {code} door de timercode (bijv. "td").

Voorbeeldverzoek:

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 dupliceren

Om een kopie te maken van een bestaande timer, stuurt u een POST-verzoek naar /duplicate/{code}. Vervang {code} door de unieke code van de timer die u wilt kopiëren. Dit maakt een nieuwe timer aan met dezelfde instellingen als het origineel.

U kunt details van de nieuwe timer bijwerken door een JSON-object toe te voegen in de request body. Hiermee kunt u specifieke attributen wijzigen, zoals de eindtijd of naam, terwijl al het andere hetzelfde blijft als het origineel. De attributen die u kunt bijwerken zijn dezelfde als die u kunt instellen bij het maken van een nieuwe timer (zie de Timer Model-sectie voor de volledige lijst). Als u een attribuut niet opneemt, blijft het hetzelfde als in de originele timer.

Belangrijk: De originele timer verandert niet. Alleen de nieuwe timer wordt beïnvloed door de updates die u in het verzoek stuurt.

Voorbeeldverzoek:

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 deactiveren

Om een timer te stoppen (archiveren), stuurt u een GET-verzoek naar /deactivate/{code}. Vervang {code} door de timercode.

Timer activeren

Om een timer opnieuw te activeren, stuurt u een GET-verzoek naar /activate/{code}. Vervang {code} door de timercode.

Timer verwijderen

Om een timer te verwijderen, stuurt u een DELETE-verzoek naar /delete/{code}. Vervang {code} door de timercode.