Documentação para Desenvolvedores

E-mails enviados

Recurso Descrição
GET /api/v1/email_deliveries/:id Informações do e-mail enviado
GET /api/v1/email_deliveries Listar e-mails enviados
PUT /api/v1/email_deliveries/:id/resend Reenviar e-mail enviado

Modelo de Dados

Parâmetro Obrigatório Tipo Tamanho Descrição
id N/A Integer   ID do e-mail enviado
uid N/A String 36 UID usado no cabeçalho da requisição
delivered_at N/A DateTime   Data e hora que a entrega foi realizada
failed_at N/A DateTime   Data e hora que a entrega falhou
event_code N/A String 255 Código do evento. Ver possíveis valores na lista de eventos
content N/A Text   Conteúdo do email
sent_error N/A String 255 Erro ocorrido no envio
email_notification_id N/A Integer   ID da Notificação
bank_billet_account_id N/A Integer   ID da Carteira de Cobrança.
resource_owner_id N/A Integer   ID do Objeto associado ao evento
status N/A String 255 Situação
status_occurred_at N/A DateTime   Data e hora que o status ocorreu

O ID do Objeto vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o ID do Objeto com o Código do evento.

Dicionário de Dados

status

0 Pendente
1 Enviado para o Servidor de E-mail
2 Falha no Envio para o Servidor de E-mail
3 Lido pelo Destinatário
4 Link Acessado pelo Destinatário

Informações do e-mail enviado

GET /api/v1/email_deliveries/:id

Exemplo

Requisição:
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET 'https://sandbox.boletosimples.com.br/api/v1/email_deliveries/1'
Resposta:
HTTP/1.1 200 OK
Date: Fri, 17 Oct 2014 19:46:16 GMT
Status: 200 OK
Content-Type: application/json; charset=utf-8
...

{
  "id":1,
  "content":"{}",
  "resource_owner_id":1,
  "delivered_at":'2015-03-17T03:36:08-03:00',
  "event_code":'bank_billet.generated',
  "failed_at":nil,
  "sent_error":nil,
  "uid": "2397f7fb-cb15-4bfc-8296-0a973e93e551"
}

Listar e-mails enviados

GET /api/v1/email_deliveries

Parâmetro Obrigatório Tipo Descrição
page Não Integer Número da Página
per_page Não Integer Quantidade de registros por página
event_code Não String Código do evento. Ver possíveis valores na lista de eventos
status Não Integer Status do e-mail enviado (possíveis valores)
resource_owner_id Não Integer ID do Objeto

O ID do Objeto vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o ID do Objeto com o Código do evento.

Exemplo

Requisição:
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET "https://sandbox.boletosimples.com.br/api/v1/email_deliveries?page=1&per_page=2"
Resposta:
HTTP/1.1 200 OK
Date: Fri, 17 Oct 2014 19:46:16 GMT
Status: 200 OK
Link: <https://sandbox.boletosimples.com.br/api/v1/email_deliveries?page=2&per_page=2>; rel="last", <https://sandbox.boletosimples.com.br/api/v1/email_deliveries?page=2&per_page=2>; rel="next"
Total: 4
Content-Type: application/json; charset=utf-8
...

[
  {
    "id":1,
    "content":"{}",
    "delivered_at":'2015-03-17T03:36:08-03:00',
    "resource_owner_id":1,
    "event_code":'bank_billet.generated',
    "failed_at":nil,
    "sent_error":nil,
    "uid": "2397f7fb-cb15-4bfc-8296-0a973e93e551"
  }
]

Reenviar e-mail enviado

PUT /api/v1/email_deliveries/:id/resend ou PATCH /api/v1/email_deliveries/:id/resend

Você pode reenviar e-mails enviados.

Exemplo

Requisição:
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET "https://sandbox.boletosimples.com.br/api/v1/email_deliveries/1/resend"
Resposta:
HTTP/1.1 204 No Content
Date: Fri, 17 Oct 2014 19:30:06 GMT
Status: 204 No Content
Location: https://sandbox.boletosimples.com.br/api/v1/email_deliveries/1
...