https://github.com/eduzz/postback
Receba postback com as informações de cada transação na Eduzz
https://github.com/eduzz/postback
Last synced: 4 months ago
JSON representation
Receba postback com as informações de cada transação na Eduzz
- Host: GitHub
- URL: https://github.com/eduzz/postback
- Owner: eduzz
- Created: 2024-08-27T20:26:06.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-27T20:28:37.000Z (almost 2 years ago)
- Last Synced: 2025-03-13T03:01:52.338Z (about 1 year ago)
- Size: 14.6 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Postback Eduzz
## Sobre o postback
O recurso de postback permite que você receba notificações de alguns eventos que ocorrem dentro do sistema, possibilitando que alem do produtor, o afiliado tambem tenha um melhor controle sobre seu negócio.
No momento estão disponíveis apenas as ações referentes ao **rastreamento** de campanhas:
- TRACKER.CHECKOUT - Acionado ao carregamento de um carrinho
- TRACKER.THANKYOU - Acionado quando o cliente chega até a página de obrigado
- TRACKER.BOLETO - Acionado sempre que um boleto é visualizado
As informações de alteração de status de compra estão disponíveis apenas para os produtores através do webhook. Muito em breve essas notificações estarão unificadas via postback tambem para os afiliados
---
## Cadastro de URL
1. Logue em sua conta e acesse o menu `Afiliado >> Meus Funis / Campanhas`
2. Na listagem de suas campanhas, clique no ícone conforme indicado na imagem abaixo:
3. Na tela seguinte, cadastre a URL onde você deseja receber as notificações do sistema
---
## Requisições válidas e retentativas
No caso de falha, são realizados 5 tentativas no intervalo de 12 horas ( 2m,6m,24m,2h,12h), após esse periodo sem sucesso, a postback é cancelado. Consideramos válidas todas as requisicoes que retornam o status HTTP 200.
---
## Validação
Enviamos via `header` o parametro `X-EduzzApi` , que deve ser comparada com a Chave de API do Afiliado/Produtor que receberá o postback.
---
## Parametros enviados
| Parâmetro | Descrição |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `event.action` | Ação de evento ( `TRACKER.CHECKOUT, TRACKER.BOLETO, TRACKER.THANKYOU` ) |
| `event.datetime` | Data e hora do evento no formato YYYY-MM-DD HH:MM:SS ex: 2016-10-26 22:02:25 |
| `invoice.id` | ID da fatura se houver. |
| `invoice.value` | Valor da fatura se houver |
| `invoice.status` | Status da fatura ( Ver [Tabela de status de pagamento](#tabela-de-status-da-fatura) ) |
| `invoice.paymentmethod` | Forma de pagamento ( Ver [Tabela de formas de pagamento](#tabela-de-formas-de-pagamento) ) |
| `invoice.datetime` | Data de criação da fatura ( Clicou em pagar ) no formato YYYY-MM-DD HH:MM:SS ex: 2016-10-26 22:02:25 |
| `invoice.paymentdate` | Data de pagamento se houver no formato YYYY-MM-DD HH:MM:SS ex: 2016-10-26 |
| `product.id` | Código do conteudo |
| `product.name` | Nome do conteudo |
| `customer.id` | ID do cliente se houver |
| `customer.name` | Nome do cliente se houver |
| `customer.email` | Email do cliente se houver |
| `partner.id` | ID do afiliado se houver |
| `partner.name` | Nome do afiliado se houver |
| `partner.email` | E-mail do afiliado se houver |
| `tracker.funnelkey` | Código da campanha se houver |
| `tracker.utm_source` | Referencia informada na momento do clique (Ex: [http://edz.la/XXXX?a=815959&utm_source=BANNER01](http://edz.la/XXXX?a=815959&utm_source=BANNER01)) |
| `tracker.utm_content` | Referencia informada no momento do clique (Ex: [http://edz.la/XXXX?a=815959&utm_content=BANNER02](http://edz.la/XXXX?a=815959&utm_content=BANNER02)) |
| `tracker.utm_campaign` | Referencia informada no momento do clique (Ex: [http://edz.la/XXXX?a=815959&utm_campaign=BANNER03](http://edz.la/XXXX?a=815959&utm_campaign=BANNER03)) |
| `tracker.utm_medium` | Referencia informada no momento do clique (Ex: [http://edz.la/XXXX?a=815959&utm_medium=BANNER01](http://edz.la/XXXX?a=815959&utm_medium=BANNER01)) |
| `tracker.ip` | IP de origem da transação |
| `cart.key` | Código da pagina de checkout |
| `cart.datetime` | Data de primeira abertura do checkout no formato YYYY-MM-DD HH:MM:SS ex: 2016-10-26 22:02:25 |
### Tabela de status da fatura
| ID | Status | Descrição |
| ---- | -------------------- | ------------------------------------------------------------------------------------- |
| `1` | Aberto | Fatura foi gerada ( Clicou em pagar e não foi autorizado, ou apenas gerou um boleto ) |
| `3` | Paga | Compra foi paga, o cliente já esta apto a receber o produto |
| `4` | Cancelada | Fatura Cancelada pela Eduzz |
| `6` | Aguardando Reembolso | Cliente solicitou reembolso, porem o mesmo ainda não foi efetuado |
| `7` | Reembolsado | Cliente já foi reembolsado pela eduzz |
| `8` | Em Análise | Cliente efetuou o pagamento, porém esta em análise pela instituição financeira |
| `11` | Em Recuperacao | Fatura entrou para o processo de recuperação |
### Tabela de formas de pagamento
| ID | Forma de pagamento |
| ---- | ---------------------- |
| `1` | Boleto Bancário |
| `9` | Paypal |
| `13` | Visa |
| `15` | Mastercard |
| `16` | Diners |
| `17` | Débito Banco do Brasil |
| `18` | Débito Bradesco |
| `19` | Débito Itaú |
| `21` | Hipercard |
| `22` | Débito Banrisul |
| `23` | Hiper |
| `24` | Elo |
| `25` | Paypal Internacional |
---
# Exemplos
### RAW BODY
`cart.datetime=2016-10-26+23%3A11%3A14&cart.key=000000-WJWUPJ-ZFZVIP-GBN9Y7&event.action=TRACKER.CHECKOUT&event.datetime=2016-10-26+23%3A12%3A01&request.datetime=2016-10-26+23%3A12%3A42&request.id=EDZ45PB&request.queue=b12962c493c3cafe6db4039515a6c0c7&request.tries=1&request.type=TRACKER.CHECKOUT&tracker.funnelkey=KKAAM&tracker.ip=177.43.204.90&tracker.utm_campaign=TESTE_TRACKER2&tracker.utm_content=&tracker.utm_medium=TESTE_TRACKER2&tracker.utm_source=TESTE_TRACKER`
### Suporte
Encontrou algum problema? Entre em contato com nosso [suporte](mailto://eduzz.com) e nós ficaremos felizes em ajuda-lo.