API MARKA -BUNKER
Bunker -Plataforma Marka de Inteligência em Vendas e Fidelização
Objetivo
O objetivo da API MARKA - BUNKER.MK é permitir que, com o menor esforços possível, os parceiros desenvolvedores, consigam trocar informações e assim disponibilizem para empresas com negócios físicos e/ou digitais, motores de fidelização e ferramentas que ofereçam uma melhor experiência de compra para seus consumidores.
Introdução
A integração ocorre por uma webservice SOAP contendo diferentes métodos para que ocorra a troca de informações entre as soluções.
Todo processo foi baseado na experiência de compra do usuário, podendo ser aplicado tanto para e-commerce quanto para lojas físicas, por isso as chamadas foram divididas e pensadas em formas de fases que serão detalhadas nesse documento e o retorno foi pensado em ações de fidelização.
Para cada fase a Software House deverá enviar a chamada Bunker_o_que_devo_fazer e a fase do atendimento, em cada fase o Bunker.MK poderá retornar uma ação, ao todo são 8 ações nomeadas de A a H, poderá ser enviado somente uma ação ou algumas ações combinadas.
O retorno foi desenvolvido para ser um padrão para todas as chamadas com o intuito de facilitar a integração além de tornar a customizável o retorno para cada cliente sem que seja necessário uma alteração da Software House para cada cliente.
Mesmo o retorno sendo padrão e contemplando todos as ações de fidelização, ele nunca será enviado com todas as ações válidas em uma só fase.
Diagrama de Atividades:
No diagrama está descrito todo o processo de interação com o sistemas e separado quais as chamas da Software House e o quando o Bunker.MK irá retornar alguma informação.
Link para melhor visualização da imagem
Experiência do cliente
Procuramos detalhar aqui como será a experiência do cliente concernente a interação, com as fases de interação criadas abaixo atendemos qualquer tipo de interação como Softwares de Vendas, Pré - vendas, PDVs, E-commerces e etc.
Fases da Interação:
Fase 1 - Inicio do Atendimento
Na Fase 1 deverá ser enviado os dados do cliente e contempla o início do atendimento, contendo a fase de cadastro do usuário, atualização dos cadastros do usuário ou identificação do usuário. Nessa fase também é possível já disponibilizar alguma ação de fidelização, como Tícket de Oferta, campanha, mensagem ou saldo de pontos do cliente.
Fase 2 - Oferta de Produto
Na Fase 2 deverá ser enviados os dados dos produtos para disponibilizar ações de fidelização referente aos produtos que estão sendo comprados pelo cliente, mostrando itens relacionados ao hábito de compra, à categoria, grupo, sub grupo, etc. Nessa fase também é possível já disponibilizar alguma ação de fidelização, como Tícket de Oferta, campanha, mensagem ou saldo de pontos do cliente.
Fase 3 - Fim do Atendimento
Na Fase 3 deverá ser enviados os produtos que serão comprados, é possível aplicar descontos e/ou preços diferenciados conforme regras do programa fidelidade de cada cliente. Nessa fase também é possível já disponibilizar alguma ação de fidelização, como Tícket de Oferta, campanha, mensagem ou saldo de pontos do cliente.
Fase 4 - Inicio da Venda
Na Fase 4 deverá ser enviado os dados do cliente e contempla o início da venda, caso não haja atendimento, ou cliente não tenha passado pelo atendimento é possível fazer o cadastro do usuário, atualização dos cadastros do usuário ou identificação do usuário. Deverá ser enviado também os dados dos produtos. Nessa fase também é possível já disponibilizar alguma ação de fidelização, como Tícket de Oferta, campanha, mensagem ou saldo de pontos do cliente.
Fase 5 - Subtotal
Na Fase 5 deverão ser enviados todos os dados da venda e será retornado se há preço diferenciado e/ou percentual de desconto que deverá ser aplicado para a quantidade mínima de compra para um produto específico, ou o desconto poderá ser aplicado sobre o total da compra. Nessa fase também é possível já disponibilizar alguma ação de fidelização, como Tícket de Oferta, campanha, mensagem ou saldo de pontos do cliente.
Fase 6 - Pagamento
Na Fase 6 todos os dados da venda com descontos aplicados deverão ser enviados e será retornado o saldo final e data de validade.
Fase 7 - Estorno da Venda
A Fase 7 deverá ser utilizada no caso de estorno total ou parcial de venda, deverá ser enviado todos os dados dos itens estornados, o Bunker realizará o estorno dos pontos e retornará os dados.
Premissas:
- Todos as estrutura de retorno da API (MK) terá informações de erro se ocorrer
| FASES DE INTERAÇÃO |
|---|
| Momento de Interação | SH envia para MK | MK devolve para SH |
|---|---|---|
| Fase 1- Inicio do Atendimento | CPF ou e-mail ou telefone ou número do cliente/cartão, enfim informações que permitam a identificação do cliente. | Cadastro do cliente e indica os campos que deverão ser complementados, conforme parâmetros dos campos requeridos e obrigatórios. |
| Fase 2- Oferta de produto | Envia informações dos produtos a cadas inserção do carrinho de compras | Informações promocionais para fidelização do cliente através daquele produto. |
| Fase 3- Fim do Atendimento - Preços Diferenciados, Descontos, Tícket de Ofertas, Mensagens ou Campanhas. (Estágio 2) | Envia informações da Pré-venda. | Mensagem de texto para ser exibida e/ou URL do tícket de ofertas para ser exibida/impressa e/ou URL de uma campanha e/ou código, descrição, preço diferenciado e/ou percentual de desconto que deverá ser aplicado para a quantidade mínima de compra para um produto específico. |
| Fase 4- Inicio da Venda | Será enviada informações do cliente, produtos e venda | Receberá estrutura de retorno parametrizados com Tícket de Ofertas, campanhas e saldo atualizado. |
| Fase 5- Subtotal | Neste momento as informações da venda serão enviadas novamente para verificação de novas campanhas associados ao cliente, valor e produtos da venda. | Com base nessa informações, a Marka poderá devolver a URL do tícket de ofertas para ser exibida/impressa e/ou URL de uma campanha e/ou código, descrição, preço diferenciado e/ou percentual de desconto que deverá ser aplicado para a quantidade mínima de compra para um produto específico, ou o desconto à ser aplicado sobre o total da compra. Retorna valor de descontos que poderão ser aplicado na venda. |
| Fase 6- Pagamento | Envio das informações finais da venda com descontos aplicados | O Resgate e atualização dos pontos serão aplicados, será retornado o saldo atualizado do cliente e informações do período que poderá ser utilizado. |
| Fase 7- Estorno da Venda | Envio de informações de estorno de venda, seja total ou parcial por produtos | Realiza o estorno total se todos os produtos registrados na venda forem recebidos, ou então o estorno parcial caso apenas alguns produtos sejam recebidos. Será realizado o estorno da pontuação obtida e enviado o retorno da pontuação atualizada. |
| Informações de retorno das interações |
|---|
| Estrutura de dados | Possíveis fases | Descrição da estrutura | Ação para implementação |
|---|---|---|---|
| Ação A - Cadastro | Fase 1 e Fase 4 | Esta estrutura retorna todas as informações do cliente que esteja na base de dados. | Ao receber esta estrutura, os dados deverão ser preenchidos no formulário de cadastro do cliente. |
| Ação B - T.O. | Todas as fases | Será retornando uma URL que mostrará o tícket de ofertas com possibilidade de impressão. | Ao receber esta estrutura deverá ser aberto uma tela com o link (URL) que será retornada. |
| Ação C - Campanha | Todas as fases | Será retornado uma URL que mostrará as informações da campanha. | Ao receber esta estrutura deverá ser aberto uma tela com o link (URL) que será retornada. |
| Ação D - Mensagem | Todas as fases | Mensagens que serão parametrizadas no sistema Bunker.MK. | Ao receber esta estrutura deverá abrir uma tela para exibição da mensagem. |
| Ação E - Lista de Ofertas | Fase 2 e Fase 5 | Será retornado uma estrutura de dados contendo informações de produtos que serão sugeridos no momento daquela venda. | Ao receber esta estrutura, deverá abrir uma tela listando os produtos permitindo a adição delas na venda. |
| Ação F - Desconto | Fase 5 | Será retornando o valor máximo de desconto que poderá ser aplicado na venda. | Ao receber esta estrutura o valor máximo deverá ser exibido na tela da venda para o vendedor poder aplicar o valor de desconto que será indicada pelo cliente. |
| Ação G - Cupom | Fase 1 e Fase 4 | Esta estrutura só será retornada se um número de cupom de desconto form enviado para ao Bunker.MK. | Ao receber esta estrutura, deverá ser informado na sistema se o cupom foi validado ou não e qual valor de desconto foi gerado. |
| Ação H - Saldo | Todas as fases | Esta estrutura poderá ser retornada a qualquer momento conforme parametrização no Bunker.MK. | Ao receber estra estrutura, deverá ser exibindo em tela o valor de saldo do cliente. |
| PARÂMETROS SH (Por empresa e não único para MK) |
|---|
| TEMPO DE ESPERA - Marcar tempo de espera diferente do retorno da Marka para os seguintes momentos: 1 - Pré-venda: Tempo recomendado de espera - Até 6 segundos; 2 - Venda: Tempo recomendado de espera - Até 3 segundos. Caso a Marka não devolva a informação nesse tempo, o processo de pré-venda ou de venda deverá ser continuado sem as informações da Marka. A seguinte mensagem de erro deverá ser exibida: "O sistema de fidelidade está sem conexão. As vantagens serão computadas automaticamente. Resgate poderá ser feito quando a comunicação normalizar." |
|---|
| QUEDA DE COMUNICAÇÃO - Caso haja queda de comunicação, os dados de cadastro e informações das vendas deverão ser guardadas e reenviadas automaticamente para o sistema da Marka quando as comunicações forem normalizadas. |
| ESTÁGIOSDAINTERAÇÃO - Estágios do processo de pré-venda e venda para um consumidor em um PDV. Estágios previamente definidos no topo do documento. |
| ATUALIZACADASTRO - Parametrizar se a atualização do cadastro do consumidor será realizada no estágio de pré-venda (2) e/ou venda(5). |
| RESGATE - Criar campo para definir se deverá enviar ou não senha ou token para resgate. |
| FORMA DE RESGATE - Criar parâmetro para definir se a loja irá contabilizar o resgate como desconto ou como forma de pagamento. |
Observações para a SH:
- Quando o consumidor não estiver cadastrado, enviar o campo CPF ou código do consumidor preenchido apenas com 0.
- Sempre enviar o nome do atendente/vendedor nos processos de interação. Sempre enviar o nome do atendente/vendedor e caixa no processo de envio das vendas.
- Sempre quando houver um cancelamento ou estorno de vendas, chamar as funções implementar a Fase 7 desta documentação.
- Sempre que incluir, alterar ou excluir um produto, deverá atualizar no sistema Bunker.MK.
- Validar com a Marka quais os campos de categorias de produtos que serão fundamentais para filtros e ações de relacionamento.
- Sempre que contratar ou demitir um funcionário, deverá atualizar as informação no Bunker.MK.
- O link do webservice deverá ser substituível empresa à empresa.