Pular para o conteúdo
Central de Ajuda

Como posso reenviar gatilhos para o meu webhook?

Como reenviar gatilhos para o seu webhook

Esse artigo irá lhe ensinar como:

• Consultar os gatilhos de uma fatura.

• Disparar novamente um gatilho específico.

• Reenviar todos os gatilhos em um intervalo de tempo.

Case de uso

"Cliente informa que sofreu uma instabilidade, ou problemas internos em seu servidor responsável por uma API que recebe os gatilhos da iugu, como ele deve consultar os gatilhos enviados nesse período?"

Diagrama de integração modelo

Diagrama de sequência entre E-commerce/Sistema e iugu: consultar faturas, consultar os gatilhos de uma invoice, disparar um gatilho novamente e reenviar gatilhos em um intervalo de tempo

Consultar todos os gatilhos de uma fatura

Primeiro você precisa do invoice_id da fatura.

Para realizar essa consulta é necessário ter o invoice_id que deseja consultar os logs. Essa propriedade é retornada ao realizar uma cobrança direta/criar fatura. Você pode armazenar esse id do lado da sua aplicação, ou consultar em nossa API “Listar Faturas”. Essa API retorna uma lista das faturas em sua conta ordenadas pela data de criação, da mais à menos recente.

Por padrão, este endpoint retorna no máximo 100 registros. O campo "totalItems" contém sempre a quantidade total de faturas cadastradas, independentemente dos parâmetros de pesquisa utilizados, e o resultado da pesquisa fica sempre dentro de "items".

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/invoices?limit=50&api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966'

Modelo de response

Exemplo de resposta da API Listar Faturas, com o campo id de cada fatura

Obs.: Se você for consultar as faturas na iugu, a propriedade que deve usar para a próxima request é a id.

Com o id deve ser realizada uma request na API “Listar Logs”. Ela irá retornar todos os gatilhos enviados para uma determinada cobrança.

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/web_hook_logs/FEDCE596BC95427BB8A9A6CC9E0429B4?api_token=(número e letras do código) \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966' \
--data-raw ''

Modelo de retorno

Exemplo de retorno da API Listar Logs, com os gatilhos enviados para a fatura

Disparar novamente um gatilho específico

Use o id do gatilho retornado pela API Listar Logs.

A API “Listar Logs” retorna o id do gatilho. Com esse id é necessário realizar um GET na API “Disparar log novamente”. Essa requisição irá retornar as informações do gatilho desejado e reenviá-lo para o webhook cadastrado na plataforma.

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/web_hook_logs/141519C9CF0446F79BACD1D89BF5679F/retry?api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966' \
--data-raw ''

Modelo de response

Exemplo de resposta da API Disparar log novamente

Reenviar todos os gatilhos em um intervalo de tempo

Informe a data inicial e a final no corpo da request.

Para realizar esse procedimento, basta realizar a chamada de GET na API “Reenviar gatilho (por período)”. No corpo dessa request deve ser informada a data inicial e final para reenvio dos logs, no formato AAAA-MM-DD.

Reenvio de 3 em 3 dias

Para essa request é possível realizar o reenvio para o intervalo de 3 em 3 dias, porém a consulta pode ser feita para logs anteriores a três dias.

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/web_hooks/resend?api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966' \
--data-raw '{
"initial_date": "2021-03-03",
"final_date": "2021-03-06",
"event": "invoice.status_changed"
}'

Modelo de response

Exemplo de resposta da API Reenviar gatilho por período

Documentações que também podem te ajudar

Como funcionam os gatilhos e como configurá-los?

Como reenviar gatilhos para o seu webhook

Esse artigo irá lhe ensinar como:

• Consultar os gatilhos de uma fatura.

• Disparar novamente um gatilho específico.

• Reenviar todos os gatilhos em um intervalo de tempo.

Case de uso

"Cliente informa que sofreu uma instabilidade, ou problemas internos em seu servidor responsável por uma API que recebe os gatilhos da iugu, como ele deve consultar os gatilhos enviados nesse período?"

Diagrama de integração modelo

Diagrama de sequência entre E-commerce/Sistema e iugu: consultar faturas, consultar os gatilhos de uma invoice, disparar um gatilho novamente e reenviar gatilhos em um intervalo de tempo

Consultar todos os gatilhos de uma fatura

Primeiro você precisa do invoice_id da fatura.

Para realizar essa consulta é necessário ter o invoice_id que deseja consultar os logs. Essa propriedade é retornada ao realizar uma cobrança direta/criar fatura. Você pode armazenar esse id do lado da sua aplicação, ou consultar em nossa API “Listar Faturas”. Essa API retorna uma lista das faturas em sua conta ordenadas pela data de criação, da mais à menos recente.

Por padrão, este endpoint retorna no máximo 100 registros. O campo "totalItems" contém sempre a quantidade total de faturas cadastradas, independentemente dos parâmetros de pesquisa utilizados, e o resultado da pesquisa fica sempre dentro de "items".

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/invoices?limit=50&api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966'

Modelo de response

Exemplo de resposta da API Listar Faturas, com o campo id de cada fatura

Obs.: Se você for consultar as faturas na iugu, a propriedade que deve usar para a próxima request é a id.

Com o id deve ser realizada uma request na API “Listar Logs”. Ela irá retornar todos os gatilhos enviados para uma determinada cobrança.

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/web_hook_logs/FEDCE596BC95427BB8A9A6CC9E0429B4?api_token=(número e letras do código) \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966' \
--data-raw ''

Modelo de retorno

Exemplo de retorno da API Listar Logs, com os gatilhos enviados para a fatura

Disparar novamente um gatilho específico

Use o id do gatilho retornado pela API Listar Logs.

A API “Listar Logs” retorna o id do gatilho. Com esse id é necessário realizar um GET na API “Disparar log novamente”. Essa requisição irá retornar as informações do gatilho desejado e reenviá-lo para o webhook cadastrado na plataforma.

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/web_hook_logs/141519C9CF0446F79BACD1D89BF5679F/retry?api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966' \
--data-raw ''

Modelo de response

Exemplo de resposta da API Disparar log novamente

Reenviar todos os gatilhos em um intervalo de tempo

Informe a data inicial e a final no corpo da request.

Para realizar esse procedimento, basta realizar a chamada de GET na API “Reenviar gatilho (por período)”. No corpo dessa request deve ser informada a data inicial e final para reenvio dos logs, no formato AAAA-MM-DD.

Reenvio de 3 em 3 dias

Para essa request é possível realizar o reenvio para o intervalo de 3 em 3 dias, porém a consulta pode ser feita para logs anteriores a três dias.

Modelo de request

curl --location --request GET 'https://api.iugu.com/v1/web_hooks/resend?api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=ca1be8a3bc81800098d0c3711c4f38bddca4926f-1626092966' \
--data-raw '{
"initial_date": "2021-03-03",
"final_date": "2021-03-06",
"event": "invoice.status_changed"
}'

Modelo de response

Exemplo de resposta da API Reenviar gatilho por período

Documentações que também podem te ajudar

Como funcionam os gatilhos e como configurá-los?

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 2
Ainda precisa de ajuda? Nosso time responde pela sua conta iugu.
Abrir solicitação

0 Comentários

Artigo fechado para comentários.