CountdownMail API

Inicio rapido

Esta secao vai prepara-lo para usar a API CountdownMail e mostrar como fazer sua primeira solicitacao de API.

1. Obtenha sua chave de API:
   • Faca login na sua conta CountdownMail.
   • Va para Perfil » API.
   • Copie sua chave de API.
2. Faca sua primeira solicitacao de API:
   • Usaremos o endpoint "Criar um temporizador" como exemplo.
   • Use uma ferramenta como cURL ou Postman para enviar uma solicitacao POST para https://countdownmail.com/api/create.
   • Adicione sua chave de API no cabecalho Authorization.
   • Inclua os detalhes necessarios do temporizador no corpo da solicitacao (em formato JSON).

Aqui esta 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, voce recebera uma resposta como esta:

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

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

Autenticacao

Para usar a API CountdownMail, voce precisa autenticar cada solicitacao com sua chave de API. Veja como:

• Adicione um cabecalho Authorization a sua solicitacao. O valor e sua chave de API.
• Alternativamente, use autenticacao basica: defina sua chave de API como nome de usuario e deixe a senha vazia.

Exemplo com cabecalho 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 autenticacao, ou voce recebera um erro 401 Unauthorized.

Usando Postman

Se voce usa Postman, ele facilita o teste de solicitacoes de API. Para usa-lo com CountdownMail:

• Clique para importar a colecao de API CountdownMail.
• Adicione sua chave de API as configuracoes de autenticacao da colecao e voce estara pronto para comecar a fazer solicitacoes.

Erros

As vezes, as solicitacoes de API falham. A API CountdownMail usa codigos de status HTTP para informar o que deu errado. Aqui esta uma lista de possiveis erros, o que significam e o que fazer:

Exemplo de resposta de erro (401 Unauthorized):

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

Se voce vir um erro, verifique o codigo de status e a mensagem e siga a acao sugerida.

Modelo do temporizador

O recurso Timer contem todas as informacoes sobre o temporizador de contagem regressiva. Estes sao os campos disponiveis 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, voce deve fornecer todas as propriedades obrigatorias.

Exemplo de solicitacao:

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

Atualizar um temporizador

Este endpoint permite atualizar qualquer atributo do temporizador. Para atualizar um temporizador, envie uma solicitacao PUT para /update/{code} com os campos que deseja atualizar. Substitua {code} pelo codigo do temporizador (ex., "td").

Exemplo de solicitacao:

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

Duplicar um temporizador

Para fazer uma copia de um temporizador existente, envie uma solicitacao POST para /duplicate/{code}. Substitua {code} pelo codigo unico do temporizador que deseja copiar. Isso cria um novo temporizador que comeca com as mesmas configuracoes do original.

Voce pode atualizar os detalhes do novo temporizador adicionando um objeto JSON no corpo da solicitacao. Isso permite alterar atributos especificos, como a hora de termino ou o nome, mantendo todo o resto igual ao original. Os atributos que voce pode atualizar sao os mesmos que pode definir ao criar um novo temporizador (consulte a secao Modelo do temporizador para a lista completa). Se voce nao incluir um atributo, ele permanece o mesmo do temporizador original.

Importante: O temporizador original nao muda. Apenas o novo temporizador e afetado pelas atualizacoes que voce envia na solicitacao.

Exemplo de solicitacao:

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

Desativar um temporizador

Para parar um temporizador (arquivar), envie uma solicitacao GET para /deactivate/{code}. Substitua {code} pelo codigo do temporizador.

Ativar um temporizador

Para ativar um temporizador novamente, envie uma solicitacao GET para /activate/{code}. Substitua {code} pelo codigo do temporizador.

Excluir um temporizador

Para excluir um temporizador, envie uma solicitacao DELETE para /delete/{code}. Substitua {code} pelo codigo do temporizador.