API para desenvolvedores do VookMail
Crie caixas de entrada temporárias e leia mensagens nos seus próprios aplicativos com uma API REST simples. As respostas são em JSON.
Autenticação
Envie sua chave de API no cabeçalho Authorization. As chaves são emitidas pelo proprietário do site.
curl https://www.vookmail.com/api/v1/domains \
-H "Authorization: Bearer vk_your_key"
Endpoints
URL base: https://www.vookmail.com/api/v1
| Método | Caminho | Descrição |
|---|---|---|
| GET | /domains | Listar os domínios disponíveis |
| POST | /mailboxes | Criar uma caixa. Corpo: nome de usuário e domínio, ambos opcionais |
| GET | /mailboxes/{address} | Detalhes da caixa e validade |
| POST | /mailboxes/{address}/extend | Prorrogar a duração da caixa |
| DELETE | /mailboxes/{address} | Fechar a caixa e excluir as mensagens |
| GET | /mailboxes/{address}/messages?after={id} | Listar mensagens, com os códigos e links detectados |
| GET | /mailboxes/{address}/messages/{id} | Ler uma mensagem: HTML higienizado, texto e anexos |
| DELETE | /mailboxes/{address}/messages/{id} | Excluir uma mensagem |
| GET | /mailboxes/{address}/messages/{id}/attachments/{attachment} | Baixar um anexo |
Exemplo
curl -X POST https://www.vookmail.com/api/v1/mailboxes \
-H "Authorization: Bearer vk_your_key" \
-H "Content-Type: application/json" \
-d '{"username":"myapp"}'
{"address":"myapp@example.com","token":"...","expires_at":"2026-10-31T12:00:00+00:00"}
Erros e limites
Os erros retornam um status HTTP com error.code e error.message. Cada chave tem um limite por minuto; ao ultrapassá-lo, o status retornado é 429.
