A plataforma da Beasy possibilitará a implementação de integrações JSON para importação/exportação de dados. Para a utilização de todos os métodos é necessário enviar no cabeçalho(header) de todas as solicitações o valor do token do usuário, o token é gerado quando o usuário é criado no painel administrativo da Beasy. Para que o webservice interprete qual usuário está solicitando informações é necessário enviar o token em todas as solicitações.
A versão da API também deve ser enviada como version no cabeçalho da requisição. Por padrão o valor é 1.
Este pacote é destinado a integração com o ERP do mercado. Nele estão todas as integrações necessárias para um bom funcionamento do sistema.
Para testes utilize os valores abaixo:
URL: http://sandbox.beasy.mobi
Token: 582bc29a313ad74224b1f996c9fe5a39
Em caso de dúvidas entre em contato.
Este grupo é responsável por gerenciar as informações de cada cliente individualmente.
Realiza a alteração do cliente no sistema.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é responsável por buscar os cliente a partir do CPF, o CPF pode ser enviado com pontuação ou sem.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é responsável por buscar os cliente a partir do E-mail.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Realiza a busca do cliente a partir do ID da Beasy.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é responsável por buscar os cliente a partir do CPF, o CPF pode ser enviado com pontuação ou sem.
O campo “tipo_cadastro” é enviado para distinguir por onde o cliente foi inserido no sistema. Os tipos de clientes são:
1 - Cadastro via Aplicativo
2 - Cadastro via Administrativo
3 - Cadastro via Site
4 - Cadastro via Landing Page
5 - Importação do ERP
6 - Importação de outros CRM’s
7 - Outros
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Retorna uma lista de clientes que realizaram o cadastro via aplicativo.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Key | Value | Description |
---|---|---|
pagina | 0 |
Este grupo é responsável por retornar todos os clientes que necessitam de atualização. Quando um cliente alterar qualquer informação de seu perfil na Beasy, via painel administrativo ou via aplicativo, seus dados atualizados são enviados para esta integração. O ERP deve consultar constantemente esta integração a fim de mantar atualizado os dados de seus clientes no ERP. Após consultar e atualizar os clientes é necessário confirmar a atualização, assim novos clientes são disponibilizados nesta API.
Este webservice é reponsável por informar ao sistema que os clientes retornados na API /rest/clientes foram atualizados com sucesso, com isso o servidor atualiza a lista de clientes e na próxima consulta retorna novos clientes.
Deve ser disparado imediatamente após a atualização dos Clientes.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é reponsável por retornar todos os clientes que necessitam de atualização, ou seja, quando um cliente altera qualquer informação referente ao seu perfil é enviado para o este webservice.
Após a requisição é necessário enviar uma confirmação para o webservice via PUT, assim será liberado novos clientes.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Estes webservices são responsáveis pelo gerenciamento dos clubes do sistema.
Este webservice é responsável por adicionar o cliente no clube. O ID do clube é o valor cadastrado na Beasy como id_erp
.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice retorna a lista de clientes que participam de um determinado clube. São retornados 25 clientes por página, o último parametro informado na URL é responsável pela paginação da lista de clientes.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é responsável por alterar as informações dos produtos disponibilizados nos clubes. O produto é vinculado ao código EAN ou código interno, quando o produto possuir o código já cadastrado no clube realiza a alteração do mesmo.
Não é possível alterar em qual clube o produto está disponível.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é responsável por excluir um produto do clube.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice para cadastro dos produtos do Clube. É enviado via POST os valores em JSON referentes ao produto, é possível enviar mais de um produto por vez. No exemplo abaixo são enviados dois produtos.
O id_erp
refere-se ao ID do clube criado no sistema ERP do supermercado, o produto pode ser vinculado a mais de um clube, para isso deve ser enviado novamente o produtos alterando o id_erp
.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este pacote é responsável por inserir todos as compras realizadas pelos clientes do sistema. Não é recebida nenhuma compra que o CPF do cliente não esteja cadastrado no sistema. Os valores enviados na compra devem condizer com os valores pagos pelo cliente.
É de extrema importância que seja enviado apenas compras confirmadas, onde não houve o extorno ou devolução de produtos.
valor
- Total pago pelo cliente com descontos
economia
- Total economizado pelo cliente na compra
loja
- Número da loja informado no ERP
ecf
- Emissor do cupom fiscal (Pode ser o numero do PDV)
cupom
- Número do cupom fiscal
Webservice para cadastro das compras efetuadas por um cliente. É enviado via POST os valores em JSON referentes à compra, é possível enviar mais de uma compra por vez e mais de um produto por compra. No exemplo abaixo são enviadas dois produtos de exemplo.
As compras não são processadas em tempo real. A compra é salva em nosso servidor e processada durante o dia, garantindo uma segurança dos dados recebidos.
É possível alterar os valores de uma compra quando enviada novamente. Para que isso ocorra os valores da loja
, ecf
e cupom
devem ser os mesmos.
loja
- o ID da loja no ERP, esse valor deve ser informado no sistema da Beasy no cadastro do supermercado.
ecf
- emissor do cupom fiscal ou outro valor que diferencie entre os PDV’s.
cupon
- cupom fiscal da compra.
cpf
- o campo CPF deve ser informado somente nas compras onde o cliente informou o CPF. Para compras sem CPF envie o campo em branco.
Para realizar a filtragem dos produtos é utilizada a GPC (Classificação Global de Produtos) feita pela GS1 Brasil. Caso o mercado opte por não enviar os campos de filtragem não é necessário inserir os mesmos no JSON.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Esta API é responsável por inserir uma devolução, conhecida como DDM. Quando enviada deve ser vinculada ao valor da compra antes realizada pelo cliente. Deve ser enviada a loja, cupom e ecf para distinguir entre as compras.
É necessário enviar os produtos que foram removidos da compra.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Retorna as informações de importação das compras e seu status.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice para edição dos produtos do Encarte. É enviado via POST os valores em JSON referentes ao produto, é possível enviar mais de um produto por vez.
O id_erp
refere-se ao ID do encarte criado no sistema ERP do Supermercado, o encarte pode ser vinculado a um ou mais supermercados.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice responsável por excluir um produto do sistema.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice para cadastro dos produtos do Encarte. É enviado via POST os valores em JSON referentes ao produto, é possível enviar mais de um produto por vez. No exemplo abaixo são enviadas dois produtos de exemplo.
O id_erp
refere-se ao ID do encarte criado no sistema ERP do Supermercado, o encarte pode ser vinculado a um ou mais supermercados.
O destaque
é necessário quando o produto deve receber um destaque dos demais produtos pertencentes a este encarte, produtos destaque são os primeiros a aparecer nas buscas e/ou acessos.
O link
é utilizado para redirecionar o produto para um link específico da Web. Envie o link completo para funcionar corretamente.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é responsável por modificar um encarte/tablóide de ofertas no sistema. O encarte possui data de início e término das ofertas.
O id_erp
é o campo responsável por realizar a integração entre o ERP e o sistema da Beasy. Este valor deve ser único.
O campo status
pode receber os valores de 1 ou 2, ativo e inativo respectivamente, caso não for enviado o valor padrão é 1.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice responsável por excluir um encarte do sistema.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Este webservice é responsável por inserir um novo encarte/tablóide de ofertas no sistema. O encarte possui data de início e término das ofertas.
O id_erp
é o campo responsável por realizar a integração entre o ERP e o sistema da Beasy. Este valor deve ser único.
O campo status
pode receber os valores de 1 ou 2, ativo e inativo respectivamente, caso não for enviado o valor padrão é 1.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Estas API’s são responsáveis por enviar notificações para os clientes, conforme desejado.
Envia uma notificação para um cliente em específico conforme o CPF enviado.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 | |
Content-Type | application/json |
Confirma que as últimas ofertas retornadas foram liberadas, retornando novas ofertas pendentes na próxima busca.
Deve ser disparada imediatamente após a liberação das ofertas no frente de caixa.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Retorna as ofertas que foram “pegas” pelos clientes de 25 em 25 para liberar a oferta pelo CPF
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
As ofertas personalizadas são ofertas criadas dentro da Beasy para um público específico e único. As ofertas são vinculadas ao CPF dos clientes.
Faz a ligação entre o código da oferta gerado no ERP e a oferta do painel Beasy.
Deve ser disparado imediatamente após o cadastro da oferta no ERP.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 | |
Content-Type | application/json |
Retorna a(s) oferta(s) que foram criadas no painel Beasy mas não foram integradas no ERP.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice para edição dos produtos em ofertas no dia. Este webservice é destinado para produtos que devem ganhar um destaque extra entre as demais ofertas. É limitado até 25 itens por loja.
O id_loja_erp
refere-se ao ID cadastrado no ERP do Supermercado. O ID das lojas deve ser único.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice para cadastro dos produtos em ofertas no dia. Este webservice é destinado para produtos que devem ganhar um destaque extra entre as demais ofertas. É limitado até 25 itens por loja.
O id_loja_erp
refere-se ao ID cadastrado no ERP do Supermercado. O ID das lojas deve ser único. O id_loja_erp
deve ser cadastrado no sistema da Beasy.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Webservice responsável por remover uma oferta.
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 | |
Content-Type | application/json |
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 2 |
API para cadastro das categorias do Encarte. É enviado via POST os valores em JSON referentes a categoria. ,
O id_erp
refere-se ao ID da categoria criado no sistema ERP do supermercado, a categoria pode ser vinculado a mais de um encarte, para isso deve ser enviado novamente o encarte alterando o id_erp
. O id_pai
refere-se ao ID da categoria do qual esta categoria herda.
O id_pai
não é um itém obrigatório. O codigo_erp_pai
refere-se ao ID da categoria pai criado no sistema ERP do supermercado, a categoria pai pode ser vinculado a mais de uma categoria filha.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |
Está API Rest retorna os últimos clientes que tiveram alguma atualização nas suas informações cadastradas dentro do intervalo de tempo específicado na url.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |
Esta API faz a integação com o ERP inserindo uma loja por vez no banco de dados.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |
Esta API deve ser requisitada apenas após a integração dos pedidos com o ERP, pois essa API altera o estado dos pedidos informando que eles já foram integrados.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |
Estorna um pedido que tenha sido realizado no delivery
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |
Retorna os dados do pedido identificado pelo id que é passado como parâmetro na URL.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |
Retorna os ultimos cinco pedidos que estão prontos para a integração com o ERP para a emissão de Nota Fiscal.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |
Esta API faz a integração do ERP com a plataforma, cadastrando os produtos, um por vez, e relacionado-os com as lojas no qual ele estará disponível. O loja_erp
refere-se ao ID da loja criado no sistema ERP do supermercado.
Key | Value | Description |
---|---|---|
token | 582bc29a313ad74224b1f996c9fe5a39 | |
version | 3 |