![\"WGC](\"https://www.wgcsistemas.com.br/novo/images/logo.png\"){kind=logo}
Seja bem vindo à documentação da API WGC ChatBot!
\n\n\nEsta API foi desenvolvida para que clientes do WGC possam integrar o nosso ERP aos principais chatbots existentes no mercado, podendo assim criar uma solução omnichannel de atendimento aos seus clientes.
\n
\n\nObservem que existem nos exemplos a utilização de variáveis no formato {{nome da variável}}. Estas variáveis são usadas tanto na URL que é usada para a chamada dos endpoints, quanto no corpo das requisições posts. É sempre necessário obviamente substituir a variável por um dado real na hora de chamar a API.
\nVamos listar aqui então alguns destes parâmetros usados, explicando os essenciais:
\n
urlBase: Substitua esta variável pelo endereço de chamada ao servidor de aplicação do WGC. Lembrando que esta URL deverá ser acessível para o ambiente do chatbot que está fazendo a chamada. Desta forma, solicite à sua equipe de segurança que faça a liberação e/ou redirecionamentos necessários para que o chatbot consiga se comunicar com a API.
\nchave: É a chave de integração informada pela WGC quando você contrata a utilização desta API. Se ainda não possui, solicite a nossa equipe comercial.
\n\n\nReparem sempre à direita da documentação, que além do exemplo do request, também existem os exemplos de repostas. Vale dizer também que pode existir mais de um exemplo. Isso é muito útil quando queremos mostrar mais de um tipo de resposta que a API pode trazer.
\nSe tiverem alguma dificuldade na utilização da API, não deixem de abrir seu ticket pela através da nossa central de atendimento.
\n
Este endpoint permite abrir um ticket dentro do WGC para um cliente.
\nBody:
\nRetornos:
\nEste endpoint permite cadastrar senha de acesso para um cliente, caso ele ainda não tenha. \nAtenção! Este endpoint não muda a senha de um cliente que já possui senha. Para validar se o cliente possui a senha cadastrada, utilize o endpoint confirmaCliente.\nO sistema vai validar a combinação de CPF/CNPJ e Telefone ou CPF/CNPJ e E-mail enviados. Basta que o e-mail ou telefone do cliente estejam iguais ao do cadastro no WGC, e a senha será cadastrada.
\nBody:
\nRetornos:
\nEste endpoint permite confirmar se o CPF/CNPJ enviado é de um cliente e se o mesmo já possui senha cadastrada.
\nRetornos:
\nEste endpoint permite realizar o desbloqueio em confiança de um contrato que esteja bloqueado.\nPara verificar se o contrato de um cliente pode ser desbloqueado antes de chamar este endpoint, você poderá chamar o endpoint verificaPossibilidadeDesbloqueio.
\nRetornos:
\nEste endpoint é normalmente chamado para definir se será apresentada a opção de desbloqueio para o cliente durante a conversa, evitando assim que ele escolha esta opção desnecessariamente e que tenha que tratar erro na chamada do endpoint desbloqueioConfianca.
\nRetornos:
\nEste endpoint permite enviar por e-mail os boletos em aberto de um determinado cliente / contrato. Recomendamos o uso prévio do endpoint listarPendenciasFinanceiras para ter certeza da existência de pendências, antes de oferecer esta opção ao cliente.
\nRetornos:
\nEste endpoint traz uma lista de áreas de suporte vísiveis externamente e cadastradas no WGC para serem apresentadas para os clientes escolherem ao abrir um ticket, através do endpoint AbrirTicketCliente.
\nRetornos:
\nEste endpoint traz uma lista de áreas de suporte vísiveis externamente e cadastradas no WGC para serem apresentadas para os clientes escolherem ao abrir um ticket, através do endpoint AbrirTicketCliente.
\nRetornos:
\nEste endpoint traz uma lista de contratos ativos, bloqueados ou suspensos de um determinado cliente para serem apresentados durante uma conversa e possam escolher para qual deles será o atendimento. A descrição do contrato retornada é composta pelo número do contrato seguido do endereço de instalação cadastrado no WGC.
\nRetornos:
\nEste endpoint traz uma lista de contratos ativos, bloqueados ou suspensos de um determinado cliente para serem apresentados durante uma conversa e possam escolher para qual deles será o atendimento. A descrição do contrato retornada é composta pelo número do contrato seguido do endereço de instalação cadastrado no WGC.
\nRetornos:
\nEste endpoint traz uma lista de boletos em aberto do contrato de um determinado cliente para serem apresentados durante uma conversa.
\nRetornos:
\nurlBoleto:\nEsta propriedade retornada dentro da cada boleto, traz a URL pública de acesso ao boleto em PDF. Ela é muito importante pois será usada, caso desejem enviar o PDF dentro da conversa para o cliente. Vale lembrar que os chatbots não armazenam conteúdo e que, quando suportado, o envio de PDF é feito através do envio da URL do conteúdo desejado, neste caso o PDF do boleto.
\n","urlObject":{"protocol":"http","path":["Wgc.Service.Web","svcChatbot.svc","listarPendenciasFinanceiras","{{chave}}","{{idCliente}}","{{idContrato}}"],"host":["{{urlBase}}"],"query":[],"variable":[]}},"response":[{"id":"b3c0ab6c-f5f6-49f3-b180-ac77f29b2116","name":"Exemplo listarPendenciasFinanceiras","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://{{urlBase}}/Wgc.Service.Web/svcChatbot.svc/listarPendenciasFinanceiras/{{chave}}/{{idCliente}}/{{idContrato}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 11 Mar 2020 15:29:06 GMT"},{"key":"Content-Length","value":"327"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"codigoBarras\": \"75691.41349 01021.861800 04920.500016 1 79870000007990\",\n \"dtVencimento\": \"20/08/2019\",\n \"idContrato\": 18076,\n \"idFatura\": 272955,\n \"urlBaseCentral\": \"sac.meudominio.com.br\",\n \"urlBoleto\": \"sac.meudominio.com.br/NotaFiscal/BoletoExterno?idBoleto=390631&idCliente=33&idFilial=1\",\n \"valor\": 79.9,\n \"valorFormatado\": \"R$ 79,90\"\n }\n]"}],"_postman_id":"faabd3c2-cf08-4202-a013-efe3349421f0"},{"name":"loginCliente","id":"adeb4cc2-67f0-4ef4-8b3b-b15d5ce99183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"IdAreaTicket\": \"1\"\n}"},"url":"http://{{urlBase}}/svcChatbot.svc/loginCliente/{{chave}}/{{cpfCliente}}/{{senhaCliente}}","description":"Este endpoint permite realizar o login do cliente e obter o idCliente, que será usado em todas consultas e operações posteriores em um fluxo de atendimento.
\nRetornos:
\nEste endpoint permite registrar rapidamente um ticket dentro do WGC para um cliente. Diferente do endpoint AbrirTicketCliente que permite envio de mensagem, escolha de área, este endpoint não oferece nada disso. Ele serve apenas para registro de um protocolo de atendimento ao fim de qualquer serviço realizado, dentro de uma conversa, quando por exemplo se envia um boleto para um cliente.
\nVale dizer que o ticket aberto por este endpoint, já é criado e fechado imediatamente, visto que serve para registrar atendimentos já realizados.
\nBody:
\nRetornos:
\nTodos os endpoints disponibilizados possuem um parâmetro comum na URL, já citado na sessão Parâmetros.
\nNão esqueça de obter a chave de integração e mudar a variável nas URLS para usar a chave.\nVejam abaixo a relação de todos os endpoints disponíveis:
\n","_postman_id":"1e71535b-a3af-4e50-888a-634c5a8442bb"}],"event":[{"listen":"prerequest","script":{"id":"a2ecf92f-4532-4903-9af4-a2dfd78ddf13","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b689b393-50f8-45ff-829e-22b54f251e3b","type":"text/javascript","exec":[""]}}]}