Primeiros passos
Crie uma API key
Enviar e gerenciar usam uma key. Ler emails usa outra, criada em outro lugar. Escolha a que combina com o que você está construindo.
De qual key você precisa?
Mail & Graph
Enviar e gerenciar
Para enviar email e para todo o resto da API: domínios, contatos, rastreamento, remetentes e logs.
Criada em
Dashboard, página Developer
Abrir a página DeveloperLer emails
Ler uma caixa postal
Para ler, buscar e organizar os emails de uma conta de email.
Criada em
Webmail, Configurações de cada conta de email
Abrir WebmailMail & Graph
Enviar e gerenciar
Uma key da página Developer funciona em mail.sendcorex.com e graph.sendcorex.com.
- 1
Abra a página Developer
Entre em app.sendcorex.com e vá até a página Developer do dashboard.
Abrir página Developer - 2
- 3
Envie em toda requisição
Passe-a no header Authorization em mail.sendcorex.com e graph.sendcorex.com.
Authorization: Bearer YOUR_API_KEYLer emails
Ler uma caixa postal
Essas keys são criadas dentro do Webmail, uma para cada conta de email, e usadas em g.sendcorex.com.
- 1
Abrir Webmail
Acesse webmail.sendcorex.com e entre com a conta de email que você quer ler.
Abrir Webmail - 2
Vá em Configurações
Abra a seção Configurações dessa conta de email.
- 3
Gere a key
Crie a API key lá e copie. Cada conta de email tem a sua.
curl -s https://g.sendcorex.com/v1 \
-H "Authorization: $TOKEN" \
-H "Content-Type: application/json" \
-d '{"commands":[{"command":"list_folders"}]}'curl -s https://g.sendcorex.com/v1/token/refresh \
-H "Content-Type: application/json" \
-d "{\"refresh_token\":\"$REFRESH\"}" Envie o token como Authorization: <token> ou Authorization: Bearer <token>. Os tokens começam com S.C.G. e o refresh token com R.S.C.G.
Uma caixa postal por key
A key define de quem são os emails que você lê. Nenhum argumento na requisição consegue escolher outro dono.
Tokens expiram
Um token expirado retorna TOKEN_EXPIRED. Troque o par com Refresh Token. O refresh token usado para de funcionar na hora.
Keys revogadas
Um token fica em cache por até 1 hora, então um token revogado pode continuar funcionando até esse cache expirar.
Rate limit
15 requisições por segundo e 15 ao mesmo tempo, por IP e caixa postal. Acima disso você recebe 429 RATE_LIMITED com um header Retry-After.
Erros de autenticação
O que a API de leitura de emails retorna quando o problema é a key.
| Código | HTTP | Quando |
|---|---|---|
MISSING_AUTH_HEADER | 401 | A requisição não tem header Authorization. |
INVALID_TOKEN | 401 | Formato errado, token desconhecido ou revogado. |
TOKEN_EXPIRED | 401 | O token passou da validade. Use o refresh token. |
RATE_LIMITED | 429 | Mais de 15 requisições por segundo ou 15 em andamento. |
AUTH_UNAVAILABLE | 503 | A autenticação está temporariamente indisponível. |