CountdownMail API

Início rápido

Esta seção vai prepará-lo para usar a API CountdownMail e mostrar como fazer sua primeira solicitação de API.

1. Obtenha sua chave de API:
   • Faça login na sua conta CountdownMail.
   • Vá para Perfil » API.
   • Copie sua chave de API.
2. Faça sua primeira solicitação de API:
   • Usaremos o endpoint "Criar um temporizador" como exemplo.
   • Use uma ferramenta como cURL ou Postman para enviar uma solicitação POST para https://countdownmail.com/api/create.
   • Adicione sua chave de API no cabeçalho Authorization.
   • Inclua os detalhes necessários do temporizador no corpo da solicitação (em formato JSON).

Aqui está um exemplo 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"
}'
                                    

• Substitua YOUR_API_KEY pela sua chave de API real.
• Se tudo funcionar, você receberá uma resposta como esta:

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

Esta resposta inclui um código de temporizador (ex., "td") e uma URL para a imagem do temporizador.

Autenticação

Para usar a API CountdownMail, você precisa autenticar cada solicitação com sua chave de API. Veja como:

• Adicione um cabeçalho Authorization à sua solicitação. O valor é sua chave de API.
• Alternativamente, use autenticação básica: defina sua chave de API como nome de usuário e deixe a senha vazia.

Exemplo com cabeçalho Authorization (cURL):

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

• Substitua YOUR_API_KEY pela sua chave de API real.
• Sempre inclua autenticação, ou você receberá um erro 401 Unauthorized.

Usando Postman

Se você usa Postman, ele facilita o teste de solicitações de API. Para usá-lo com CountdownMail:

• Clique para importar a coleção de API CountdownMail.
• Adicione sua chave de API às configurações de autenticação da coleção e você estará pronto para começar a fazer solicitações.

Erros

Às vezes, as solicitações de API falham. A API CountdownMail usa códigos de status HTTP para informar o que deu errado. Aqui está uma lista de possíveis erros, o que significam e o que fazer:

Exemplo de resposta de erro (401 Unauthorized):

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

Se você vir um erro, verifique o código de status e a mensagem e siga a ação sugerida.

Modelo do temporizador

O recurso Timer contém todas as informações sobre o temporizador de contagem regressiva. Estes são os campos disponíveis para definir um temporizador de contagem regressiva:

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

Criar um temporizador

Este endpoint permite criar um temporizador. Para criar um novo temporizador, você deve fornecer todas as propriedades obrigatórias.

Exemplo de solicitação:

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

Atualizar um temporizador

Este endpoint permite atualizar qualquer atributo do temporizador. Para atualizar um temporizador, envie uma solicitação PUT para /update/{code} com os campos que deseja atualizar. Substitua {code} pelo código do temporizador (ex., "td").

Exemplo de solicitação:

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

Duplicar um temporizador

Para fazer uma cópia de um temporizador existente, envie uma solicitação POST para /duplicate/{code}. Substitua {code} pelo código único do temporizador que deseja copiar. Isso cria um novo temporizador que começa com as mesmas configurações do original.

Você pode atualizar os detalhes do novo temporizador adicionando um objeto JSON no corpo da solicitação. Isso permite alterar atributos específicos, como a hora de término ou o nome, mantendo todo o resto igual ao original. Os atributos que você pode atualizar são os mesmos que pode definir ao criar um novo temporizador (consulte a seção Modelo do temporizador para a lista completa). Se você não incluir um atributo, ele permanece o mesmo do temporizador original.

Importante: O temporizador original não muda. Apenas o novo temporizador é afetado pelas atualizações que você envia na solicitação.

Exemplo de solicitação:

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

Desativar um temporizador

Para parar um temporizador (arquivar), envie uma solicitação GET para /deactivate/{code}. Substitua {code} pelo código do temporizador.

Ativar um temporizador

Para ativar um temporizador novamente, envie uma solicitação GET para /activate/{code}. Substitua {code} pelo código do temporizador.

Excluir um temporizador

Para excluir um temporizador, envie uma solicitação DELETE para /delete/{code}. Substitua {code} pelo código do temporizador.