Ativação - Pedidos de compras por WhatsApp - GoDeep

Este documento descreve como habilitar a opção de compra por WhatsApp na plataforma Deep B2C e como utilizar os endpoints da integração.

Requisitos

Para fazer a integração com o catálogo de produtos e realizar vendas no WhatsApp é necessário:

Contratar um plano com a Dawntech + Blip

Utilizar a plataforma Deep B2C

Configuração

Toda a configuração é realizada diretamente pelo time da Dawntech.

Após a contratação do plano, a Dawntech e o cliente devem solicitar à GoDeep o token de integração.

Integração GoDeep
Passo 1 - Habilitar o módulo

O usuário F1 deve acessar o ambiente de B2C do cliente (www.seudominio.com.br/admin), ir à tela de módulos e habilitar o módulo Compra por WhatsApp.

Com esse módulo ativo, os endpoints de Compra por WhatsApp são habilitados. Eles estão detalhados a partir do Passo 3.

*Passo 2 - Obter o token da API
*
O usuário F1 deve acessar o ambiente de B2C do cliente (www.seudominio.com.br/admin) e ir em Configurações > Gerais > Aba API F1 > Campo Token da API Laravel.

Esse token deve ser copiado e repassado ao parceiro que vai utilizar os endpoints para fazer a integração com a plataforma.

*Passo 3 - Endpoints disponíveis
*
Com o módulo ativo no Passo 1, ficam habilitados todos os endpoints necessários para o parceiro gerar uma URL de compra.

Todos os endpoints usam o método POST, inclusive os de consulta.

#	Endpoint	Método	URL
1	Consultar Cliente	POST	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp/consultar-cliente`
2	Cadastrar Cliente PF	POST	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp/cadastrar-cliente/PF`
3	Cadastrar Cliente PJ	POST	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp/cadastrar-cliente/PJ`
4	Validar Token	POST	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp/validar-token`
5	Consultar Produtos	POST	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp/consultar-produto`
6	Consultar Frete	POST	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp/consultar-frete`
7	Dados de Compra	POST	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp/dados-compra`

*Passo 4 - Autenticação
*
Todos os endpoints usam a mesma forma de autenticação. A diferença está apenas no body de cada requisição.

**URLs base
**

#	Ambiente	URL base
1	Homologação	`http://proxy.b2c-frontapi-imp.f1ws.com.br/api/whatsapp`
2	Produção	`http://proxy.b2c-frontapi.f1ws.com.br/api/whatsapp`

Token

O token é o fornecido no Passo 2 pelo time da F1. Ele é necessário para o parceiro se autenticar nos endpoints e deve ser enviado no padrão Bearer Token.

Headers

Authorization: Bearer {token}
Content-Type: application/json

Body

No body da requisição devem ser enviados os parâmetros de consulta correspondentes a cada requisição.

*Passo 5 - Como utilizar os endpoints
*
**1. Consultar Cliente
**
Fazer a autenticação conforme o Passo 4. No body, passar o CPF ou CNPJ do cliente que deseja consultar (somente números).

A resposta é um JSON com o cadastro do cliente pesquisado.

**2. Cadastrar Cliente PF
**
Fazer a autenticação conforme o Passo 4. No body, passar os parâmetros necessários para cadastrar o cliente CPF.

#	Campo	Regra
1	senha	Passar um valor aleatório
2	sexo	`masculino`, `feminino` ou `outro`
3	newsletter	Passar sempre `N`
4	recaptcha	Passar sempre `false`
5	telefones, cpf, cep	Enviar somente números
6	dataNascimento	Padrão `dd/mm/aaaa`

Com os dados corretos, a resposta da requisição é "Cliente efetuado com sucesso".

Respostas possíveis

#	Situação	Retorno
1	Dados corretos	"Cliente efetuado com sucesso"
2	Cliente já cadastrado	Informa que o e-mail ou CPF já existem
3	Dado inválido	Aponta o campo com erro, um por vez, conforme a prioridade dos campos. Exemplo: se CPF e telefone estiverem errados, primeiro acusa o CPF; ao ajustar e reenviar, acusa o telefone

Cadastrar Cliente PJ

Fazer a autenticação conforme o Passo 4. No body, passar os parâmetros necessários para cadastrar o cliente CNPJ.

#	Campo	Regra
1	senha	Passar um valor aleatório
2	sexo	Passar sempre `outro`
3	newsletter	Passar sempre `N`
4	recaptcha	Passar sempre `false`
5	telefones, cpf, cep, inscrição estadual e municipal	Enviar somente números

As respostas da requisição são as mesmas do cadastro de PF, descritas no item 2.

Validar Token

Fazer a autenticação conforme o Passo 4. No body, passar o parâmetro token da escola cujos produtos serão consultados.

Atenção: esse token não tem relação com o token de autenticação da requisição. É o código que cada escola possui e que, ao ser consultado, retorna os produtos que ela pode vender.

A resposta traz os produtos que a escola pode vender, dentro do array produtos. Esse endpoint retorna várias informações que podem não ser necessárias para a venda pelo WhatsApp - desconsiderar as irrelevantes para o processo.

Se o token da escola estiver errado, a API retorna mensagem de erro.

O endpoint de Consultar Produtos (item 5) é apenas complementar a este, já que a validação de token já retorna as principais informações do produto.

Consultar Produtos

Fazer a autenticação conforme o Passo 4. No body, passar o parâmetro busca com o valor desejado.

A busca aceita:

Código do produto
EAN do produto
Título do produto

Paginação

Cada consulta retorna no máximo 30 produtos por página. Para acessar as próximas listagens, incluir o parâmetro ?page=2 na URL e assim por diante. O array retornado traz as informações de paginação disponíveis.

Consultar Frete

Fazer a autenticação conforme o Passo 4. No body, passar os parâmetros dos produtos para os quais se deseja consultar o frete.

#	Parâmetro	Tipo	Obrigatório
1	cep	String	Sim
2	produtos	Array	Sim
3	produtos[].id	Number	Sim
4	produtos[].quantidade	Number	Sim
5	produtos[].id_convenio	Number	Não

Os itens 3 a 5 são os campos de cada objeto dentro do array produtos.

O id do convênio é retornado na consulta do item 4 (Validar Token).

A resposta traz as opções de frete disponíveis. A opção escolhida deve ser enviada na requisição de dados-compra.

Dados de Compra

Fazer a autenticação conforme o Passo 4. No body, passar os parâmetros necessários para gerar uma compra na plataforma.

Importante: uma compra ainda não é um pedido. Ela só se transforma em pedido quando o cliente escolhe a forma de pagamento e finaliza.

#	Parâmetro	Tipo	Obrigatório
1	id_cliente	Number	Sim
2	endereco	Number (ID)	Sim
3	frete	Number (ID)	Sim
4	produtos	Array	Sim
5	produtos[].id	Number	Sim
6	produtos[].convenio_categoria_id	Number	Não
7	produtos[].id_convenio	Number	Não
8	produtos[].quantidade	Number	Sim

Os itens 5 a 8 são os campos de cada objeto dentro do array produtos.

A resposta é a URL que deve ser exibida ao cliente. Ao clicar, ele é direcionado ao site em desktop ou mobile, conforme o dispositivo que estiver usando.

Atenção: após o clique, o cliente finaliza a compra no próprio site (mobile ou desktop). Não há callback da GoDeep informando se o pedido foi concluído.