BeCash API



Introdução


A API do BeCash permite ao estabelecimento, o acesso a alguns recursos de integração, podendo ser feita das formas mais variadas, visando a praticidade em integrações para estabelecimentos que necessitem desses recursos, dando a possibilidade de unificar informações de sistemas diferentes, ou simplesmente adaptar recursos do BeCash, em um sistema já em pleno funcionamento.

Toda requisição, necessita obrigatóriamente de uma chave secreta que o estabelecimento possue, para poder fazer as solicitações, dessa maneira, ao montar uma requisição para qualquer retorno da API do BeCash, o estabelecimento precisa passar como parametro esta chave para poder ser identificado.


A seguir temos os métodos disponíveis e seus tipos de retorno:

AcessoEstabelecimento/BuscarUsuario
Método utilizado para buscar os consumidores por documento ou email, o retorno deste método é id do consumidor criptografado, ex:
Retorno tipo string

GET https://becash.com.br/api/AcessoEstabelecimento/BuscarUsuario?documento&email=g.elias@becash.com.br&tokenAcesso="SUA_CHAVE_SECRETA"


Retornos:
"1|BNquTWtZVgtBNkjMHRudkacfFomfcxs14"
"2|Usuário não cadastrado"
"3|Usuário inativo"
"4|Ocorreu um erro ao fazer a busca"
AcessoEstabelecimento/BuscarUsuario
Método utilizado para buscar os consumidores por documento, email ou idBecash, o retorno deste método é um tipo complexo com os dados do consumidor, ou, caso não localizado, o campo msgErro deste retorno pode ser: "Usuário não cadastrado" ou "Usuário inativo"

GET https://becash.com.br/api/AcessoEstabelecimento/BuscarUsuario?documento&email&idBeCash=g.elias&tokenAcesso="SUA_CHAVE_SECRETA"


Retorno do modelo:
Campo Descrição
IdUsuario String com um código identificador do consumidor
Nome String com o nome do consumidor
PendenciaDeBe Bool mostrando se há pendencias de be para ao estabelecimento
DtMaiorCompra DateTime exibindo a data da maior compra
DtMenorCompra DateTime exibindo a data da menor compra
DtPrimeiraCompra DateTime exibindo a data da primeira compra
DtUltimaCompra DateTime exibindo a data da última compra
ValorBe Double com o total de be que o consumidor tem neste estabelecimento
TotalBeRedeFiliais Double com o total de bes que o consumidor tem na rede de estabelecimentos filiados
TotalBeUsados Double com o total de bes usados
TotalComprasAprovadas Decimal com o total de compras aprovadas
ValorMaiorCompra Double com o valor da maior compra neste estabelecimento
ValorMenorCompra Double com o valor da menor compra neste estabelecimento
ValorPrimeiraCompra Double com o valor da primeira compra neste estabelecimento
ValorUltimaCompra Double com o valor da última compra neste estabelecimento
msgErro String com uma mensagem de erro caso não encontre o consumidor buscado

Exemplo:

AcessoEstabelecimento/NovoUsuario
Caso o consumnidor não esteja cadastrado na base do BeCash, através deste método é possível criar um novo usuário, inserindo seu Nome e Email, e possibilitando posteriormente, efetuar uma venda para este novo consumidor cadastrado.
Retorno tipo string

GET https://becash.com.br/api/AcessoEstabelecimento/NovoUsuario?nome=Guilherme&email=g.elias@becash.com.br&tokenAcesso="SUA_CHAVE_SECRETA"



Retornos:
"1|Usuário adicionado com sucesso"
"2|Nome, Documento e Email precisam ser preenchidos"
"3|E-mail inválido"
"4|Este e-mail já está cadastrado em nosso sistema"
"5|Ocorreu um erro ao adicionar o usuário"

AcessoEstabelecimento/LancamentoComId
Método utilizado para efetuar as vendas, seu retorno é um tipo string com a notificação da transação. Seu modelo passado como parâmetro deve seguir o exemplo abaixo:
Parâmetro Descrição
IdUsuario String com o código identificador do consumidor
Valor Double com o valor da venda
DebitoBe Double com o valor de be a ser debitado do consumidor (opcional)
DebitoCash Double (passar sempre com valor 0)
DebitoOutros Double com o valor de pagamento referente a outras formas
Observacao String caso tenha alguma observação (opcional)
EmailConsumidor Int para enviar um e-mail com o comprovante da compra ao consumidor (1 = enviar email, 0 = não enviar)

Exemplo:

GET https://becash.com.br/api/AcessoEstabelecimento/LancamentoComId?IdUsuario=TlNKTWtZafojn455BKMHRudkg0ckdmdz09&Valor=65&DebitoBe&DebitoOutros=65&Observacao&tokenAcesso="SUA_CHAVE_SECRETA"


Retornos:
"1|Lançamento feito com sucesso"
"2|Lançamento feito com sucesso, aguardando aprovação do consumidor"
"3|Ocorreu um erro ao fazer o lançamento"
"4|Loja inativa"
"5|Usuário inativo"
"6|Preencha o valor de Be a ser debitado"
"7|O valor da compra precisa ser maior que zero"
"8|Os valores inseridos nos tipos de pagamento, excedem o valor total da compra"
"9|A soma dos valores preenchidos não totaliza o valor da compra"
"10|O debito de Be é maior que o Be total do consumidor"
"11|Este usuário possue compras pendentes nesta loja, seus bes só podem ser usados, após aprovar ou reprovar sua pendência"


AcessoEstabelecimento/LancamentoSemId
Método utilizado para efetuar uma venda sem o ID do usuário atrelado, seu retorno é um tipo string com o caminho do QR Code gerado para o consumidor escanear pelo app, ao escanear seu QR Code, automaticamente é gerada a venda. Seu modelo passado como parâmetro deve seguir o exemplo abaixo:
Parâmetro Descrição
Valor Double com o valor da venda
Exemplo:

GET https://becash.com.br/api/AcessoEstabelecimento/LancamentoSemId?Valor=5.99&tokenAcesso="SUA_CHAVE_SECRETA"


Retornos:
"1|Url_Do_QRCode"
"2|Ocorreu um erro ao gerar esta venda"
"3|Ocorreu um erro ao gerar o QR Code"