API vendas
API de vendas
Desenvolvemos uma API padrão que pode ser adotada por todas as empresas parceiras que desejam vender ingressos através da integração de sistemas. A API é integrada diretamente com o banco de dados do sistema Volpe, permitindo consultas em tempo real.
O Volpe controlará a numeração dos ingressos gerados e notificará o parceiro no momento da venda.
Na aba comercial > API de integração, são gerenciadas todas as funcionalidades necessárias para o funcionamento da API.
Como realizar a integração com um novo parceiro?
Os parceiros precisarão ser cadastrados previamente para utilizar as integrações e ao serem cadastrados serão geradas as informações de autenticação para uso da API.
O cadastrado é feito a partir do modulo Integradores > Incluir. É essencial criar uma senha segura, pois ela será utilizada pelo parceiro para realizar a integração posteriormente.
Após o cadastro do parceiro serão definidas as formas de pagamento e limites de venda disponibilizados.
O limite de venda representa o montante máximo que o parceiro pode comercializar até que ocorra o encerramento da conta.
Com o cadastro concluído, o parceiro interessado na integração deverá seguir o passo a passo disponibilizado para ele através do link https://apivendas.pwi.com.br/prod
Com o cadastro realizado e a senha disponibilizada pela equipe do parque, recomendamos o consumo da API em ambiente de homologação, para que se possa validar todos os métodos descritos nesse documento.
OBS: Consulte a equipe do parque, se eles dispõe de um ambiente de homologação
Como fazer a adição dos produtos para o parceiro?
Quando realizado o cadastro do parceiro serão também vinculados os produtos que estarão disponíveis para venda.
Clique com o botão direito e selecione 'incluir' para adicionar os produtos individualmente.
Os ingressos que serão apresentados na API devem estar configurados corretamente; eles são cadastrados normalmente, conforme explicado no manual. https://manuais.pwi.com.br/e-commerce/ingressos#Ingressos-Cadastrodeingressos
Para disponibilizar o ingresso na API de parceiros, ele deve estar configurado corretamente na aba "Comercial", com o checkbox marcado e a disponibilidade de venda ajustada conforme o desejado.
Como consultar as vendas realizadas pelo parceiro?
Quando o parceiro realizar a venda ao cliente final e concluir as integrações, as informações de vendas serão registradas no Volpe, e os ingressos serão gerados para impressão pelo parceiro. É possível consultar todas as vendas realizadas.
Quais são as formas de pagamento aceitas na API?
Dinheiro: É acrescentando uma quantia, normalmente acertada já com antecedência com o parceiro, é uma forma de pagamento pré paga.
Conta consumo: A modalidade Conta Consumo também é uma forma de pagamento pré-paga. É disponibilizado um limite para o parceiro, que é utilizado como um crédito. Assim que a conta é fechada o saldo da conta consumo volta para o saldo inicial.
Para a utilização dessa forma de pagamento, é necessário criar uma conta consumo e incluir o saldo ao parceiro.
Como determinar o valor de comissão para o parceiro?
É possível determinar um valor em % para calcular o valor de comissão para a venda de cada parceiro. Ao fechar a conta esse valor já calculado aparecerá descriminado corretamente facilitando o pagamento a ser realizado.
Como fechar uma conta do parceiro para pagamento?
Para efetuar o fechamento de conta da API, acesse a aba 'Comercial', depois 'Fechamento de Canais por Comissionado', escolha a data para o fechamento e selecione a empresa desejada.
Para efetuar o fechamento específico da API de vendas, é essencial utilizar o filtro de canais de venda.
O fechamento de canais de vendas detalha os valores exatos das vendas, o montante a ser recebido pelo parque, a comissão devida, entre outros.
Caso o parceiro ultrapasse o limite de vendas estabelecido, ele será bloqueado para novas vendas até que o fechamento e o pagamento sejam realizados. Se a conta for fechada e ainda houver um limite de vendas disponível, o parceiro poderá prosseguir com as vendas até que este limite seja alcançado.
Como fazer o acompanhamento do limite do parceiro?
É possível realizar um acompanhamento detalhado das vendas do parceiro, o que permite um controle mais eficaz sobre as transações realizadas e ajuda a identificar o momento ideal para concluir o fechamento de contas.
É possível vender ingressos que possuem sessão horaria através da Api?
Sim, em determinadas situações, as regras referentes às datas disponíveis de um produto são determinadas por um controle de sessão, esse controle é denominado Grupo de Sessão. Nesses casos, a API irá verificar no momento da geração do pedido, se a data e o produto preterido para compra estão disponíveis tanto para a data selecionada como em quantidade de ingressos.
Quais as principais mensagens retornadas na API?
“Parceiro bloqueado, entre em contato com o administrador da conta”
Mensagem exibida para contas a receber pendentes.
“Parque fechado”
Mensagem exibida quando há grande possibilidade de uma data não estar cadastrada no calendário.
“Sessão não encontrada para a data da compra: ''
Mensagem exibida nos casos em que o dia da venda não estiver disponível para o Grupo de Sessão do item.
“Produto sem saldo de sessão disponível”
Mensagem exibida quando a quantidade de ingressos disponíveis na sessão , é inferior à quantidade solicitada no momento da compra.
“Conta consumo não encontrada”
Mensagem exibida quando não tem conta consumo disponível.