Endpoint Compras por WhatsApp
Neste documento está descrito como habilitar a opção de compra por WhatsApp e como utilizar os endpoint’s.Passo 1#
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, vai habilitar os endpoint’s de Compra por WhatsApp, que serão detalhados no “Passo 3” em diante.Passo 2#
O usuário F1, deve acessar o ambiente de B2C do cliente www.seudominio.com.br/admin, ir à tela “Configurações > Gerais > Aba API F1 > Campo Token da API Laravel”. Deve copiar esse token e passar para o parceiro que vai utilizar os endpoint’s para fazer a integração com a plataforma.Passo 3#
Com o módulo ativo no “Passo 1”, serão habilitados todos os endpoint’s necessários para o parceiro conseguir gerar uma url de compra. Todos os endpoint’s usam o método “POST”, mesmo os que são para consultar dados. Nos próximos passos, iremos detalhar a usabilidade de cada endpoint.Passo 4#
Todos os endpoint usarão a mesma forma de autenticação, a diferença estará apenas no “BODY” da requisição de cada endpoint.3.
O token -> Esse é o token fornecido no “Passo 2” pelo time da F1. E será necessário para que o parceiro realize a autenticação em nossos endpoint’s O Token precisa ser enviado no padrão “Bearer Token”.
5. O header das requisições deve ter o “Content-Type:application/json”7.
No body da requisição devem ser enviados os parametros de consulta correspondentes a cada requisição.Exemplo da requisição para consulta de cliente. Envia somente o parâmetro “cpf_cnpj_cli”, e o retorno são os dados do cliente.
Exemplo da requisição para cadastro de cliente PF. Envia todos os parâmetros necessários para se cadastrar um cliente na plataforma.
Passo 5#
Nos próximos itens serão descritos COMO UTILIZAR OS ENDPOINT’S1.
Consultar Cliente -> Fazer a autenticação conforme “Passo 4”. No “Body” da requisição passar o parâmetro e o CPF ou CNPJ do cliente que deseja consultar (Somente números). 2.
Cadastrar Cliente PF -> Fazer a autenticação conforme “Passo 4”. No “Body” da requisição passar os parâmetros necessários para cadastrar o cliente CPF.
Obs. 2: No caso do “sexo”, passar os valores (masculino, feminino ou outro)
Obs. 3: No caso da “newsletter”, passar sempre (N)
Obs. 4: No caso do “recaptcha”, passar sempre (false)
Obs. 5: No caso dos campos de números “telefones, cpf, cep”, enviar somente números.
Obs. 6: No caso de “dataNascimento”, passar no padrão dd/mm/aaaa
Caso os dados estejam corretos, ao fazer a requisição e o cliente for cadastrado a resposta será “Cliente efetuado com sucesso).Se o cliente já existir, a resposta será “que o e-mail ou CPF já existem”Mas se tiver algum dado errado nos paramtros a resposta será apontando o campo que está errado. A API vai apontar um campo por vez, conforme a prioridade dos campos. Se tiver errado o CPF e o telefone. Primeiro vai acusar o CPF, ao ajustar e submenter, vai acusar o telefone.3.
Cadastrar Cliente PJ -> Fazer a autenticação conforme “Passo 4”. No “Body” da requisição passar os parâmetros necessários para cadastrar o cliente CNPJ.
Obs. 2: No caso do “sexo”, passar sempre (outro)
Obs. 3: No caso da “newsletter”, passar sempre (N)
Obs. 4: No caso do “recaptcha”, passar sempre (false)
Obs. 5: No caso dos campos de números “telefones, cpf, cep. Isncrição estatual e municipal”, enviar somente números.
A resposta da resição serão as mesmas do cadastro de CPF, explicados acima (Item 5. b).4.
Validar token -> Fazer a autenticação conforme “Passo 4”. No “Body” da requisição passar o parâmetro o “token” da escola que deseja consultar os produtos que serão vendidos. Esse token não tem nada a ver com o token da requisição, esse token é o código que cada escola possui que ao consultar, será retornado os produtos que a escola pode vender.
Dentro do array “produtos”, serão retornados os produtos da escola.
Caso o token da escola esteja errado, vai retornar a mensagem abaixo:O endpoint de “Consultar Produto”, no (Item 5. e) é apenas complementar a este, porque nesse endpoint do token já retorna as principais informações do produto.5.
Consultar Produtos -> Fazer a autenticação conforme “Passo 4”. No “Body” da requisição passar o parâmetro “busca” para consultar o produto desejado.
ter acesso a segunda listagem, basta inserir juntamente na url o parâmetro “?page=2” e
sucessivamente.
No array retornado irá ter as informações de paginações possíveis para consulta.6.
Consultar Frete -> Fazer a autenticação conforme “Passo 4”. No “Body” da requisição passar os parâmetros dos produtos que deseja consultar o frete. cep: (Obrigatório, String);
produtos: (Obrigatório, Array):
id: (Obrigatório, Number);
quantidade: (Obrigatório, Number);
id_convenio: (N/O, Number);
A resposta serão as opções de frete disponíveis para serem escolhidas no fechamento do pedido, enviar na requisição de “dados-compra” a opção escolhida.7.
Dados de Compra -> Fazer a autenticação conforme “Passo 4”. No “Body” da requisição passar os parâmetros necessário para gerar uma compra na plataforma.
Lembrando que uma compra ainda não é um pedido. Somente se transformará em pedido quando o cliente escolher a forma de pagamento e finalizar.
Dados esperados na requisição de compra: id_cliente: (Obrigatório, Number);
endereco: (Obrigatório, Number): (ID)
frete: (Obrigatório, Number): (ID)
produtos (Obrigatório, Array):
id (Obrigatório, Number);
convenio_categoria_id: (Não obrigatório, Number);
id_convenio: (Não obrigatório, Number);
quantidade: (Obrigatorio, Number);
Modificado em 2025-06-27 13:34:59
