CountdownMail API

Avvio rapido

Questa sezione ti preparera a usare l'API CountdownMail e ti mostrera come fare la tua prima richiesta API.

1. Ottieni la tua chiave API:
   • Accedi al tuo account CountdownMail.
   • Vai a Profilo » API.
   • Copia la tua chiave API.
2. Fai la tua prima richiesta API:
   • Useremo l'endpoint "Creare un timer" come esempio.
   • Usa uno strumento come cURL o Postman per inviare una richiesta POST a https://countdownmail.com/api/create.
   • Aggiungi la tua chiave API nell'header Authorization.
   • Includi i dettagli richiesti del timer nel corpo della richiesta (in formato JSON).

Ecco un esempio usando 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"
}'
                                    

• Sostituisci YOUR_API_KEY con la tua chiave API reale.
• Se tutto funziona, otterrai una risposta come questa:

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

Questa risposta include un codice timer (es., "td") e un URL per l'immagine del timer.

Autenticazione

Per usare l'API CountdownMail, devi autenticare ogni richiesta con la tua chiave API. Ecco come:

• Aggiungi un header Authorization alla tua richiesta. Il valore e la tua chiave API.
• In alternativa, usa l'autenticazione di base: imposta la tua chiave API come nome utente e lascia la password vuota.

Esempio con header Authorization (cURL):

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

• Sostituisci YOUR_API_KEY con la tua chiave API reale.
• Includi sempre l'autenticazione, altrimenti riceverai un errore 401 Unauthorized.

Usare Postman

Se usi Postman, rende facile testare le richieste API. Per usarlo con CountdownMail:

• Clicca per importare la collezione API CountdownMail.
• Aggiungi la tua chiave API alle impostazioni di autenticazione della collezione, e sei pronto per iniziare a fare richieste.

Errori

A volte, le richieste API falliscono. L'API CountdownMail usa codici di stato HTTP per dirti cosa e andato storto. Ecco un elenco dei possibili errori, il loro significato e cosa fare:

Esempio di risposta di errore (401 Unauthorized):

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

Se vedi un errore, controlla il codice di stato e il messaggio, poi segui l'azione suggerita.

Modello Timer

La risorsa Timer contiene tutte le informazioni sul timer per il conto alla rovescia. Questi sono i campi disponibili per definire un timer per il conto alla rovescia:

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

Creare un timer

Questo endpoint ti permette di creare un timer. Per creare un nuovo timer, devi fornire tutte le proprieta richieste.

Esempio di richiesta:

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

Aggiornare un timer

Questo endpoint ti permette di aggiornare qualsiasi attributo del timer. Per aggiornare un timer, invia una richiesta PUT a /update/{code} con i campi che vuoi aggiornare. Sostituisci {code} con il codice del timer (es., "td").

Esempio di richiesta:

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

Duplicare un timer

Per fare una copia di un timer esistente, invia una richiesta POST a /duplicate/{code}. Sostituisci {code} con il codice univoco del timer che vuoi copiare. Questo crea un nuovo timer che inizia con le stesse impostazioni dell'originale.

Puoi aggiornare i dettagli del nuovo timer aggiungendo un oggetto JSON nel corpo della richiesta. Questo ti permette di cambiare attributi specifici, come l'ora di fine o il nome, mantenendo tutto il resto uguale all'originale. Gli attributi che puoi aggiornare sono gli stessi che puoi impostare quando crei un nuovo timer (vedi la sezione Modello Timer per l'elenco completo). Se non includi un attributo, rimane lo stesso del timer originale.

Importante: Il timer originale non cambia. Solo il nuovo timer e influenzato dagli aggiornamenti che invii nella richiesta.

Esempio di richiesta:

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

Disattivare un timer

Per fermare un timer (archiviare), invia una richiesta GET a /deactivate/{code}. Sostituisci {code} con il codice del timer.

Attivare un timer

Per riattivare un timer, invia una richiesta GET a /activate/{code}. Sostituisci {code} con il codice del timer.

Eliminare un timer

Per eliminare un timer, invia una richiesta DELETE a /delete/{code}. Sostituisci {code} con il codice del timer.