Fluxo integração API Datacake
Este guia tem como objetivo apresentar o fluxo de integração da esteira de vendas Datacake atravez das APIs abertas, para que provedores e parceiros consigam melhor entender as etapas de preenchimento, informações necessárias e o passo a passo até a conclusão da venda, utilizando nossas APIs para realizar esses lançamentos conforme sua necessidade.
A Datacake fornece serviços de software para provedores de internet e seus parceiros, e uma dessas ferramentas, é o serviço de "Esteira de vendas", que de forma resumida funciona como um tipo de e-commerce.
Temos um link onde funciona esse serviço da esteira e disponibilizamos a integração também por API. O link da esteira de vendas de seu provedor será o mesmo link a ser utilizado em sua integração API.
Para enviar o pedido utilizando as APIs, é necessário seguir um "passo a passo" para montagem completa desse carrinho e envio para o sistema. Ela é estruturada em 5 partes principais, mas vou dar mais detalhes na sequência:
Pré-checagem e busca de viabilidade técnica
Criar o carrinho da venda
Adicionar o produto
Preenchimento dos dados do cliente
Conversão em pedido
A documentação com as APIs necessárias para essa criação estão todas nessa documentação:
Documentação Carrinho de Compras Provedor - Manual API Checkout
No geral, todas podem ser utilizadas para esse fluxo, porém algumas delas são obrigatórias.
Nessa documentação, todas as APIs são abertas, não sendo necessário uma pré-validação ou acesso fechado das APIs dessa documentação.
Para a primeira etapa de pré checagem, nosso sistema busca as coordenadas no mapa, e checa quais os planos disponíveis para o endereço do cliente. Existem algumas APIs diferentes que buscam as informações de endereço do cliente, mas em ordem, conforme os nomes na documentação, você deve seguir as seguintes APIs:
Pré-checagem
Pegar informações de um endereço pelo CEP (Pega as informações do endereço baseado no cep)
Pegar coordenadas de um endereço (Pega as coordenadas do endereço baseado na resposta da API anterior)
Verificar cobertura de um endereço (Busca a viabilidade baseado nas respostas das últimas duas APIs)
Salvar endereço do cliente (Salva o endereço desse cliente no sistema, ele irá retornar um ID que será utilizado na próxima etapa)
Depois de confirmar a viabilidade, é necessário criar um carrinho! Para isso, você irá utilizar a API:
Criar o carrinho da venda
Criação de carinho (Cria um carrinho no sistema Datacake. O ID criado será utilizado em todas as etapas a partir daqui)
Em caso de venda com parceiro ou vendedor, você deve buscar o seu ID de revendedor utilizando a API "Pegar ID do Revendedor" para preencher essa informação na criação de carrinho. Nesse caso o CPF ou CNPJ desse vendedor deve estar cadastrado como “revendedor” no Datacake.
Após criar o carrinho, você deve puxar os produtos disponíveis e inseri-los no carrinho criado. Para isso, você deve utilizar em ordem as seguintes APIs:
Adicionar o produto
Pegar contratos disponíveis
Pegar os planos disponíveis (Lista os planos disponíveis para o local)
Adição de produto no carrinho (Inseri produtos na esteira baseado na viabilidade. Alguns produtos tem vinculados a si obrigatoriamente opcionais, um tipo de "produto filho". Nesses casos, ao vincular o ID do "produto pai", o "produto filho" será inserido automaticamente na esteira)
Pegar os adicionais de um produto (Busca os "produtos filhos" disponíveis baseado no "produto pai" incluso no carrinho, normalmente SVAs, roteadores, etc).
É possível aplicar cupons de descontos utilizando a API "Aplicar cupom", porem eles devem estar criados dentro do sistema, e as regras desse cupom devem ser respeitadas dentro do carrinho para que seja válido. É um campo não obrigatório, então é uma etapa que pode ser pulada. Você pode pegar as informações do carrinho utilizando a API: "Pegar carrinho"
Depois, você deve preencher as demais informações do cliente, datas e formas de pagamento e envio de documentos. Para isso, você deve utilizar as seguintes APIs:
Preenchimento dos dados do cliente
Pegar dados do "Como você chegou até nós?" (Origem comercial, onde o cliente pode preencher como conheceu a Brisanet)
Pegar bancos
Pegar datas de vencimento de uma cidade (Qual a data de vencimento da fatura desejada pelo cliente)
Pegar termos de um carrinho (Termos de aceite e de adesão disponíveis na esteira que devem ser marcados)
Pegar documentos necessários (Envio de documentos do cliente, seja selfie, RG, etc).
Antes do envio, certifique-se que todas as APIs anteriores foram preenchidas e todos os dados estão completos. Em caso de dúvidas, é possível puxar as informações do carrinho atualizado na API "Pegar carrinho", e é possível editar as informações completas utilizando a API "Atualizar o carrinho".
Por fim, é só converter o carrinho em pedido! para isso, você deve utilizar a API:
Conversão de carrinho para pedido
Conversão em pedido (Converte um carrinho em pedido no Datacake, e o pedido é integrado ao Revan, o ERP da Brisanet)
Em casos de erro na conversão, o ideal é validar a resposta da API, primeiro validando se houve algum campo que não foi preenchido, se é uma mensagem de erro de conexão, ou se é algum erro de aprovação ou na própria integração do Datacake com o ERP.