Cartão Fidelidade Desconto

A api deverá ser atualizada a cada 4 meses. No primeiro dia dos seguintes mêses janeiro, maio e setembro.

O que é o Programa Fidelidade?

É um programa de fidelização do cliente iniciado pela ObjectPro em parceiria com Rede Soma Drogarias.

Como funciona?

O Sistema deve ter opção para Escolher o Modelo Prêmio ou Desconto

No Modelo por Prêmio. A cada compra o cliente acumula pontos, que poderão ser trocados por prêmios.

No Modelo por Desconto. Na hora da compra é feita uma consulta na tabela de Descontos praticada pela Rede e o cliente recebe este desconto. Em contrapartida a Rede buscará sempre fazer a melhor negociação para oferecer os melhores descontos.

URL

O Sistema deve permitir alterar a URL.

Usar logo da ObjectPro para identificação do Cartão Fidelidade, clique na imagem para baixar os arquivos de identificação

CPF TESTE

Nome	CPF
Paulo Barros	044.847.026-81

HEAD Será usado em todos os URI

Nome	Valor [Exemplo]	Descriçao
Authorization	Bearer [Solicitar Token]	Envia o token de acesso.
Content-Type	`application/json`	Envie o tipo de retorno.
user-agent	Hostname	Envia o nome do pc.
Versao	1.0.4.191	Enviar o número da versão do software.

Status Code Tabela geral usada em todos os URI

Código	Descriçao	Schema
`200`	Sucesso	`GET` – Irá exibir conteúdo
`201`	Criado/Atualizado
`202`	Aceito/Autorizado
`203`	Não autorizado
`204`	Não existe conteúdo	`GET` – Item não existe. Ex.: Produto não encontrado
`301`	Movido	`{"uri": "string"}`
`400`	Parâmetros Inválidos	`{"key": ["string"]}`
`401`	Acesso não autorizado
`402`	Pagamento necessário
`403`	Proibido
`404`	Não encontrado, verifique a URL
`405`	Método não permitido
`406`	Não executado
`408`	Tempo esgotado [Timeout]
`409`	Conflito de regras
`410`	Url Obsoleta
`412`	Falha na pré-condição
`500`	Erro interno do servidor
`501`	Recurso não implementado
`502`	Gateway Inválido
`503`	Serviço indisponível
`408,500,503`	Observação estes status devem ser tratados para não interromper a aplicação. No inicio da operação se houve alguma indisponibilidade no servidor, solicitar o balconista para voltar mais tarde, O timeout de todos os métodos é 15 segundos.

Modelo por Desconto

O Sistema deve ter opção para Escolher o Modelo Prêmio ou Desconto

GET /v2/cliente

Consulta

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome	Requerido	Descrição	Schema
cnpj	Sim	CNPJ da drogaria.	`String`
numero	Sim	CPF do cliente ou Número do Cartão	`String`

Retorno

Código	Descrição	Schema
`200`	Sucesso	`{ "id": "integer", "cpf": "string", "rg": "string", "nome": "string", "nascimento": "date: yyyy-mm-dd", "cep": "string: XXXXX-XXX", "tlog": "string", "logradouro": "string", "num": "string", "compl": "string", "bairro": "string", "cidade": "string", "uf": "string", "email": "string", "sexo": "integer: 0-Feminino,1-Masculino", "fone1": "string: (XX) XXXX-XXXX", "fone2": "string: (XX) XXXXX-XXXX", "cartao": "string: XXXX.XXXX.XXXX" }`
`204`	Não existe conteúdo	Obs: Emitir Alerta "Cliente Não Cadastrado" e dar opção de cadatrar com dados já informados
`400`	Parâmetros Inválidos	`{"key": ["string"]}`
`408,500,503`	Observação estes status devem ser tratados para não interromper a venda. No inicio da operação se houve alguma indisponibilidade no servidor, solicitar o balconista para voltar mais tarde, informando que ele deve fazer a venda fora do Cartão Fidelidade. Se durante a operação antes do fechamento da venda houver alguma indisponibilidade, não é necessário enviar a confirmação na hora no Modelo Desconto para não interromper a venda. Deve permiter concluir a venda normalmente. Sem exibição de alertas. A confirmação da venda deverá ser enviada assim que houver disponibilidade de comunicação. O timeout de todos os métodos é 15 segundos.

POST /v2/cliente

Envio

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome	Requerido	Descrição	Schema
cnpj	Sim	CNPJ da drogaria.	`String`
cpf	Sim	CPF do cliente	`String`
cartao	Sim	Número do Cartão	`String`
rg	Não	Número da Identidade [RG]	`String`
nome	Sim	Nome do Cliente	`String`
sexo	Sim	0-Feminino,1-Masculino	`integer`
nascimento	Sim	Data de Nascimento	`Date` – formato yyyy-mm-dd
email	Não	Email	`String`
fone1	Não	Telefone	`String`
fone2	Não	Telefone	`String`
fone3	Não	Telefone	`String`
tlog	Não	Tipo de Logradouro ex: Rua	`String`
logradouro	Não	Endereço	`String`
num	Não	Número	`String`
compl	Não	Complemento	`String`
bairro	Não	Bairro	`String`
cidade	Não	Cidade	`String`
uf	Não	UF, sigla do estado	`String`
cpf_vend	Sim	CPF do Balconista/Vendedor	`String`

Retorno

Código	Descrição	Schema
`201`	Criado/Atualizado
`400`	Parâmetros Inválidos	`{"key": ["string"]}`
`406`	Não executado

GET /v2/produto

Consulta

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome	Requerido	Descrição	Schema
cnpj	Sim	CNPJ da drogaria.	`String`
numero	Sim	CPF do cliente ou Número do Cartão.	`String`
ean	Sim	Código de Barras EAN do produto.	`String`

Retorno

Código	Descrição	Schema
`200`	Sucesso	`{ "ean": "7899095236400", "produto": "IBUPROFENO 100mg/ml susp oral fr gts 20ml", "desconto": 50.00, }`
`204`	Não existe conteúdo	Obs: Passar de direto sem emitir alerta
`400`	Parâmetros Inválidos	`{"key": ["string"]}`
`408,500,503`	Observação estes status devem ser tratados para não interromper a venda. No inicio da operação se houve alguma indisponibilidade no servidor, solicitar o balconista para voltar mais tarde, informando que ele deve fazer a venda fora do Cartão Fidelidade. O timeout de todos os métodos é 15 segundos.

OBS

Observação
`Não deve impedir a venda do medicamento quando o desconto não for acatado. Ex: Enviando mensagen de confirmação ou alert....`

POST /v1/produto

Envio

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome	Requerido	Descrição	Schema
cnpj	Sim	CNPJ da drogaria.	`String`
cpf_clie	Sim	CPF do cliente	`String`
cpf_vend	Sim	CPF do Vendedor[Balconista]	`String`
dtocorrencia	Sim	Data da ocorrência da venda	`DateTime` – formato `yyyy-mm-dd hh:nn:ss`
tipo	Não	Tipo de transação [0-Venda, 2-Devolução] Padrão 0-Venda	`Integer`
legado	Sim	Código que identifique a venda ou cupon no sistema da softhouse.	`Integer`
ean	Sim	EAN do produto.	`String`
produto	Não	Nome do Produto	`String`
quant	Sim	Quantidade ex: [2.00].	`Double`
bruto	Sim	Valor sem desconto ex: [10.00].	`Double`
desco	Sim	Desconto ex: [10.00]%.	`Double`
liquido	Sim	Valor pago pelo cliente ex: [9.00].	`Double`
origem	Sim	0 - Desconto da Drogaria, 1 - Desconto da Rede	`string`

Retorno

Código	Descrição	Schema
`202`	Aceito
`406`	Não executado
`400`	Parâmetros Inválidos	`{"key": ["string"]}`
`408,500,503`	Observação estes status devem ser tratados para não interromper a venda. Se durante a operação de confirmação da venda houver alguma indisponibilidade, não é necessário enviar a confirmação na hora para não interromper a venda. Deve permiter concluir a venda normalmente. Sem exibição de alertas. A confirmação da venda deverá ser enviada assim que houver disponibilidade de comunicação. O timeout de todos os métodos é 15 segundos.

OBS

Observação
`Quando o campo 'cartao' for enviado o campo 'cpf_clie' não precisa ser enviado.`
`O campo 'cpf_vend' Não está como obrigatorio mas é imprescindível para algumas redes para premiação.`
Deve ser enviado todos item da venda, independente de terem recebido desconto
`Em todas as vendas com Cartão Fidelidade deve ser identificado o cliente no Cupom Fiscal`

Relatório de Analise de impacto

Deverá ser extraído do sistema no formato .xlsx as vendas de produtos dos ultimos 90 dias. Modelo

Nota Fiscal de Entrada

POST /v1/nfe

Envio

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome	Requerido	Descrição	Schema
cnpj	Sim	CNPJ da drogaria.	`String`
chave	Sim	chave de acesso da nota no Sefaz	`String`
dtnfe	Sim	Data de Emissão da Nota Fiscal	`Date` – formato `yyyy-mm-dd`
total	Sim	Valor Total da Nota	`Number` – formato `0.00`
xml	Sim	Arquivo xml da nota	`file`