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 N/A Object   Evento relativo à entrega. Leia mais
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
bank_billet_id N/A Integer   ID do Boleto
obj_id N/A Integer   ID do Objeto associado ao evento

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
2 Com falha

Informações do e-mail enviado

GET /api/v1/email_deliveries/:id

Exemplo

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-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,
  "bank_billet_id":bank_billet1.id,
  "content":"{}",
  "delivered_at":'2015-03-17T03:36:08-03:00',
  "event": {
    "id": 212,
    "code": "bank_billet.generated",
    "data": {
      "object": {
        "id":1,
        "expire_at":"2014-11-15",
        "paid_at":null,
        "description":"Prestação de Serviço",
        "status":"opened",
        "customer_person_type":"individual",
        "customer_person_name":"Nome do Cliente",
        "customer_cnpj_cpf":"125.812.717-28",
        "customer_address":"Rua quinhentos",
        "customer_state":"RJ",
        "customer_neighborhood":"bairro",
        "customer_zipcode":"12312-123",
        "customer_address_number":null,
        "customer_address_complement":null,
        "customer_phone_number":null,
        "customer_email":null,
        "send_email_on_creation":null,
        "created_via_api":true,
        "customer_city_name":null,
        "paid_amount":0.0,
        "amount":12.34
      }
    },
    "occurred_at": "2015-03-16T22:56:05.000-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
bank_billet_id Não Integer ID do Boleto
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)

Exemplo

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-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,
    "bank_billet_id":bank_billet1.id,
    "content":"{}",
    "delivered_at":'2015-03-17T03:36:08-03:00',
    "event": {
      "id": 212,
      "code": "bank_billet.generated",
      "data": {
        "object": {
          "id":1,
          "expire_at":"2014-11-15",
          "paid_at":null,
          "description":"Prestação de Serviço",
          "status":"opened",
          "url":"http://bole.to/xxxxxxxx",
          "customer_person_type":"individual",
          "customer_person_name":"Nome do Cliente",
          "customer_cnpj_cpf":"125.812.717-28",
          "customer_address":"Rua quinhentos",
          "customer_state":"RJ",
          "customer_neighborhood":"bairro",
          "customer_zipcode":"12312-123",
          "customer_address_number":null,
          "customer_address_complement":null,
          "customer_phone_number":null,
          "customer_email":null,
          "created_via_api":true,
          "customer_city_name":null,
          "paid_amount":0.0,
          "amount":12.34
        }
      },
      "occurred_at": "2015-03-16T22:56:05.000-03:00"
    }
    "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 \
-u $BOLETOSIMPLES_TOKEN:x \
-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
...