Configurar Atualização Automática de Pedido por Webhook
Através da seção Configurações, é possível criar a inscrição no Webhook para obter atualização automática de pedidos.
O processo se resume a enviar para inscrição a URL com o Endpoint da API que deverá receber os dados e informar quais filtros o webhook deverá considerar para realizar o disparo automático. Veja a seguir como deverá funcionar.
Cadastrar e Atualizar Inscrição no Webhook
Para realizar uma inscrição no Webhook, o endpoint /pub/configuracoes/topicos-webhook do tipo POST localizado na seção Configurações, vá até a opção Cadastrar e Atualizar Inscrição no Webhook.
Conforme já mencionado anteriormente, caso os passos de acesso e autenticação tenham sido realizados, o campo AUTHORIZATION e URL já estarão com os dados necessários para prosseguir com a requisição.
Utilizando a barra de rolagem, para chegar até a seção BODY PARAMS, poderá se testar os parâmetros obrigatórios e opcionais para envio dos dados.
id: caso a requisição seja para atualizar uma inscrição existente, o usuário deverá informar neste campo a ID da inscrição que deverá ser atualizada. Caso seja um cadastro, basta deixar o campo null.
topico: refere-se ao tópico da qual está se escrevendo. Veja na requisição de exemplo abaixo.
url: endereço da api e endpoint da qual o webhook deverá enviar a atualização.
filtros: Os filtros são um array de objtos com os seguintes parâmetros:
contasOms: conta(s) que serão monitoradas pelo webhook, caso a inscrição deva ter efeito em todas as contas o sinal * deverá ser utilizado.
contasOmsIgnorar: conta(s) que serão ignoradas pelo webhook. Esse parâmetro sobrepõe o parâmetro anterior e deverá ser enviada com o valor null caso não haja contas a serem ignoradas.
idsStatus: trata-se da id do status do pedido que será notificado pelo webhook.
headers: O campo headers é um array de objetos e trata-se de parâmetros que poderão ser enviados de acordo com a necessidade da API para onde serão enviadas as atualizações. Caso não sejam necessários, os campos deverão ser enviados com valor null
chave: tipo de chave de acesso à API.
valor: valor que será enviado para a chave.
email: conta de e-mail na qual será enviada notificação em caso de falha de envio das atualizações.
observacao: campo de texto livre, para por exemplo, guardar informações sobre o motivo da inscrição.
inativo: campo que guarda o status da inscrição, possui valor padrão false.
Exemplo de requisição:
{
"id": 0,
"topico": "Pedido.Status",
"url": "https://minhaApi.teste.com.br/notificacaoStatus",
"filtros": [
{
"contaOms": ["*"],
"contaOmsIgnorar": ["Loja 1"],
"idsStatus": ["1","2"]
}
],
"headers": [
{
"chave": "Token",
"valor": "abcs"
}
],
"email": "testes@teste.com.br",
"observacao": "inscrição utilizada para integração dos pedidos com o PDV",
"inativo": false
}
Para atualizar uma inscrição no Webhook é necessário ter o seu ID, para isso, basta utilizar o endpoint /configuracoes/topicos-webhook do tipo GET.
Conforme já mencionado anteriormente, caso os passos de acesso e autenticação tenham sido realizados, o campo AUTHORIZATION e URL já estarão com os dados necessários para prosseguir com a requisição.
Utilizando a barra de rolagem, para chegar até a seção QUERY PARAMS, poderá se testar o parâmetro obrigatório para consulta dos dados.