INTRODUçãO
Objetivo
A integração com o sistema de Fidelidade visa estabelecer a comunicação entre os diversos parceiros e o programa de fidelidade.
Plataforma
Os serviços são expostos via API acessiveis por chamadas web utilizando métodos GET e POST em HTTP, que permitem que os parceiros obtenham informações de pontuação e efetivem resgate / consulta / geração de credito na base do fidelidade.
Interface da API
Os seguintes métodos são expostos nos webservices da Integração:
- PostCliente
- GetExtrato
- PostOperacao
- PostReserva
- PostEstorno
- GetSaldo
- GetProduto
A URL base da API é:
http://fidelidade.chleba.net/ws/
ACESSO A API DE INTEGRAçãO
Ao ser registrado um novo parceiro no sistema FIDELIDADE, automaticamente sera gerado um TOKEN e um LOGIN do tipo GUID que sera fornecido ao parceiro. Este código é Parametro obrigatório de todas as chamadas da API e não deve ser fornecido a outras pessoas ou empresas em nenhuma hipótese.
MéTODOS DA API
Os métodos com a nomenclatura iniciada com GET são encarregados de obter informações da base da CashBack. Todos eles são acessados diretamente por uma URL contendo o nome do método na qual devem ser fornecidos alguns parametros que estão detalhados a seguir; o retorno é fornecido via padrão JSON. O método com nomenclatura iniciada com POST é encarregado de transferir informações do parceiro para o CashBack.
PostCliente
Este método tem o propósito incluir/alterar cliente na base de dados do Fidelidade:
URL: http://fidelidade.chleba.net/ws/consumir.aspx
Método: PostCliente
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Cliente:
|
Informação |
Tipo |
Info Adicional |
Obrigatório |
|
EmpresaGuid |
string |
Sim |
|
|
ClienteCPF |
varchar(11) |
Sim |
|
|
ClienteNome |
varchar(250) |
Sim |
|
|
|
varchar(150) |
Sim |
|
|
DataNasc |
datetime |
Sim |
|
|
Sexo |
varchar(1) |
M / F |
Sim |
|
CelDdd |
varchar(2) |
Sim |
|
|
Cel |
varchar(9) |
Sim |
|
|
TelDdd |
varchar(2) |
Sim |
|
|
Telefone |
varchar(9) |
Sim |
|
|
Cep |
varchar(8) |
Sim |
|
|
Endereco |
varchar(100) |
Sim |
|
|
Numero |
varchar(20) |
Sim |
|
|
Complemento |
varchar(50) |
Sim |
|
|
UF |
varchar(2) |
Sim |
|
|
Cidade |
varchar(100) |
Sim |
|
|
Bairro |
varchar(100) |
Sim |
Envio
{
"PostCliente": {
"Cliente":{
"EmpresaGuid":" CCDA7B7D-E58E-4E36-98B4-
F400B77659FC","ClienteCPF":"02099940904","ClienteNome":"Jose da
Silva","email":"[email protected]","DataNasc":"01/01/1970","Sexo":"M","CelDdd":"04
1",""Cel":"992023322","TelDdd":"041","Telefone":"33250505","Cep":"80030001","End
ereco":"R. das flores","Numero":"1000","Complemento":"sala
3","UF":"PR","Cidade":"Curitiba","Bairro":Centro"
}
}
}
Exemplo de retorno:
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicável.
{
"codigo":0,
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"mensagem":"Operação efetuada com sucesso",
"dados_adicionais":null
}
PostOperacao
Este método tem o propósito incluir um resgate na base de dados do Fidelidade:
URL: http://fidelidade.chleba.net/ws/consumir.aspx
Método: PostOperacao
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Envio:
|
Informação |
Tipo |
Info Adicional |
|
ClienteCPF |
varchar(11) |
|
|
ClienteNome |
varchar(250) |
|
|
Clienteemail |
varchar(150) |
|
|
Data |
datetime |
|
|
LojaID |
int |
Loja id externo eclética |
|
NumeroPedido |
varchar(200) |
|
|
NumeroPedidoWeb |
varchar(200) |
Quando for web |
|
ValorPedido |
Decimal (18,2) |
|
|
EmpresaGuid |
varchar (36) |
|
|
Pdv |
Varchar(100) |
|
|
OperadorCode |
Varchar(100) |
|
|
NotaFiscalNumero |
Varchar(100) |
|
|
NotaFiscalTimeSpan |
Varchar(100) |
|
|
Frete |
Decimal (18,2) |
|
|
Desconto |
Decimal (18,2) |
|
|
OrigemVenda |
Varchar (50) |
|
Dados do itens:
|
Informação |
Tipo |
Info Adicional |
|
ProdutoNome |
varchar(5000) |
|
|
ProdutoSKU |
varchar(200) |
|
|
ValorEmPontos |
ValorEmPontos |
|
|
ValorEmReais |
Decimal (18,2) |
|
|
Quantidade |
Decimal (18,2) |
|
|
Desconto |
Decimal (18,2) |
|
|
TipoOperacao |
varchar (1) |
C=Credito/D=Débito |
{
"PostOperacao":
{
"Operacao":{
"ClienteCPF":"020029595","ClienteNome":"Jose da
Silva","Clienteemail":"[email protected]","Data":"01/01/1970
23:00","LojaID":"2222","LojaNomeFantasia":"Jardins","LojaRazãoSocial":"Jardins
Ltda","NumeroPedido":"5626",
"NumeroPedidoWEB":"CLE5626","ValorPedido":"180,00","EmpresaGuid":" 2C958E36-
F2FB-4B0E-9245-
2F84A54EE910","PDV":"rf4444","OperadorCode":"CSAZ","NotaFiscalNumero":"32424",
"NotaFiscalTimeSpan":"992223DD","Frete":"0,00", "Desconto":"0,00" ,
"OrigemVenda":" DELIVERY WEB CHLEBA",
"Operacaoitens": [
{
"ProdutoNome":"Rolinho Primavera",
"ProdutoSKU":"6565",
"ValorEmPontos":"100",
"ValorEmReais":"100",
"Quantidade":"1",
"Desconto":"0",
"TipoOperacao":"D"
},
{
"ProdutoNome":"Yaksoba",
"ProdutoSKU":"6565",
"ValorEmPontos":"",
"ValorEmReais":"100",
"Quantidade":"1",
"Desconto":"0",
"TipoOperacao":"C"
},
},
},
}
Exemplo de Retorno
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicável.
{
"codigo":0,
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"mensagem":"Operação efetuada com sucesso",
"dados_adicionais":null
}
PostReserva
Este método tem o propósito incluir uma reserva na base de dados do Fidelidade:
URL:http://fidelidade.chleba.net/ws/consumir.aspx
Método: PostReserva
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Envio:
|
Informação |
Tipo |
Info Adicional |
|
ClienteCPF |
varchar(11) |
|
|
ClienteNome |
varchar(250) |
|
|
Clienteemail |
varchar(150) |
|
|
Data |
datetime |
|
|
LojaID |
int |
Loja id externo eclética |
|
NumeroPedido |
varchar(200) |
|
|
NumeroPedidoWeb |
varchar(200) |
Quando for web |
|
ValorPedido |
Decimal (18,2) |
|
|
EmpresaGuid |
Varchar(36) |
|
|
Pdv |
Varchar(100) |
|
|
OperadorCode |
Varchar(100) |
|
|
NotaFiscalNumero |
Varchar(100) |
|
|
NotaFiscalTimeSpan |
Varchar(100) |
|
|
Frete |
Decimal (18,2) |
|
|
Desconto |
Decimal (18,2) |
|
|
OrigemVenda |
Varchar(50) |
|
Dados do itens:
|
Informação |
Tipo |
Info Adicional |
|
ProdutoNome |
varchar(5000) |
|
|
ProdutoSKU |
varchar(200) |
|
|
ValorEmPontos |
ValorEmPontos |
|
|
ValorEmReais |
Decimal (18,2) |
|
|
Quantidade |
Decimal (18,2) |
|
|
Desconto |
Decimal (18,2) |
|
|
TipoOperacao |
varchar (1) |
C=Credito/D=Débito |
Envio
{
"PostReserva":{
"Operacao":{
"ClienteCPF":"020029595","ClienteNome":"Jose da
Silva","Clienteemail":"[email protected]","Data":"01/01/1970
23:00","LojaID":"2222","LojaNomeFantasia":"Jardins","LojaRazãoSocial":"Jardins
Ltda","NumeroPedido":"5626",
"NumeroPedidoWEB":"CLE5626","ValorPedido":"180,00","EmpresaGuid":" 2C958E36-
F2FB-4B0E-9245-
2F84A54EE910","PDV":"rf4444","OperadorCode":"CSAZ","NotaFiscalNumero":"32424",
"NotaFiscalTimeSpan":"992223DD","Frete":"0,00", "Desconto":"0,00" ,
"OrigemVenda":" DELIVERY WEB CHLEBA",
"Operacaoitens": [
{
"ProdutoNome":"Rolinho Primavera",
"ProdutoSKU":"6565",
"ValorEmPontos":"100",
"ValorEmReais":"100",
"Quantidade":"1",
"Desconto":"0",
"TipoOperacao":"D"
},
{
"ProdutoNome":"Yaksoba",
"ProdutoSKU":"6565",
"ValorEmPontos":"",
"ValorEmReais":"100",
"Quantidade":"1",
"Desconto":"0",
"TipoOperacao":"C"
},
}
}
}
Exemplo de retorno:
{
"codigo":0,
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"mensagem":"Operação efetuada com sucesso",
"dados_adicionais":null
}
GetExtrato
Este método tem o propósito de retornar o extrato de pontos de um determinado cliente.
URL: http://fidelidade.chleba.net/ws/consumir.aspx
Método: GetExtrato
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Cliente:
|
Informação |
Tipo |
Info Adicional |
Obrigatório |
|
EmpresaGuid |
string |
|
Sim |
|
ClienteCPF |
varchar(11) |
|
Sim |
Exemplo de chamada:
{"postextrato":
{"extrato":
{"EmpresaGuid":"C26E28F2-0124-45FF-BB69-A5B0CDB465C",
"ClienteCPF":"02099940904"
}
}
}
Dados do retorno:
|
Informação |
Tipo |
Info Adicional |
|
ClienteCPF |
varchar(11) |
|
|
ClienteNome |
varchar(250) |
|
|
ClienteEmail |
varchar(150) |
|
|
Data |
datetime |
|
|
TipoOperacao |
Varchar(1) |
|
|
LojaID |
int |
|
|
LojaNomeFantasia |
varchar(200) |
|
|
LojaRazãoSocial |
varchar(200) |
|
|
CampanhaID |
int |
|
|
CampanhaTitulo |
varchar(200) |
|
|
NumeroPedido |
varchar(200) |
|
|
NumeroPedidoWeb |
varchar(200) |
|
|
ValorPedido |
Decimal (18,2) |
|
|
Ticket |
Varchar(36) |
|
|
PDV |
varchar(200) |
|
|
Desconto |
Decimal (18,2) |
|
|
Frete |
Decimal (18,2) |
|
|
OperadorCode |
varchar(200) |
|
|
NotaFiscalNumero |
varchar(200) |
|
|
NotaFiscalTimeSpan |
timestamp |
|
Dados do itens:
|
Informação |
Tipo |
Info Adicional |
|
ProdutoNome |
varchar(5000) |
|
|
ProdutoSKU |
varchar(200) |
|
|
ValorEmPontos |
ValorEmPontos |
|
|
ValorEmReais |
Decimal (18,2) |
|
|
Quantidade |
Decimal (18,2) |
|
|
Desconto |
Decimal (18,2) |
|
|
TipoOperacao |
varchar (1) |
C=Credito/D=Débito |
Exemplo de retorno:
{
"codigo":0,
"mensagem":"Operação efetuada com sucesso",
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"dados_adicionais":
{
{
"ClienteCPF":"020029595","ClienteNome":"Jose da
Silva","ClienteEmail":"[email protected]","Data":"01/01/1970","TipoOperacao":"Resga
te","LojaNomeFantasia":"Jardins","LojaRazãoSocial":"Jardins
Ltda","CampanhaID":"23423","CampanhaTitulo":"","NumeroPedido":"5626","NumeroP
edidoWEB":"CLT5626","ValorPedido":"","ticket":"","PDV":"998","OperadorCode":"Fiscal
","NotaFiscalNumero":"34534","NotaFiscalTimeSpan":"54466333","Desconto":"10,00","
Frete":"0",
"extratoitens": [
{
"ExtratoItem":"333",
"ProdutoNome":"Rolinho Primavera",
"ProdutoSKU":"6565",
"ValorEmPontos":"100",
"ValorEmReais":"100",
"Quantidade":"1",
"TipoOperacao":"C",
"PontosGerados":"100",
},
]
}
}
PostEstorno
Este método tem o propósito estornar pedido efetuado.
URL: http://fidelidade.chleba.net/ws/consumir.aspx
Método: PostEstorno
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Envio:
|
Informação |
Tipo |
Info Adicional |
|
LojaID |
int |
|
|
NumeroPedido |
varchar(200) |
|
|
NumeroPedidoWEB |
varchar(200) |
|
|
EmpresaGuid |
Varchar(36) |
|
Envio
{"postestorno":{"estorno":{"EmpresaGuid":"2C958E36-F2FB-4B0E-9245-
2F84A54EE910","NumeroPedido":"52365","NumeroPedidoWeb":"253","LojaID":"5"}}}
Exemplo de retorno:
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicável.
{
"codigo":0,
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"mensagem":"Operação efetuada com sucesso",
"dados_adicionais":null
}
GetSaldo
Este método tem o propósito de retornar o saldo de um determinado cliente.
URL: http://fidelidade.chleba.net/ws/consumir.aspx
Método: GetSaldo
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Cliente:
|
Informação |
Tipo |
Info Adicional |
Obrigatório |
|
EmpresaGuid |
string |
|
Sim |
|
ClienteCPF |
varchar(11) |
|
Sim |
Exemplo de chamada:
{
"postsaldo":
{
"saldojson":{
"EmpresaGuid":" C26E28F2-0124-45FF-BB69-
A5B0CDB465C5","ClienteCPF":"02099940904"
}
}
}
Dados do retorno:
|
Informação |
Tipo |
Info Adicional |
|
Saldo |
int |
|
|
Nome |
varchar(200) |
|
Exemplo de retorno:
{
"codigo":0,
"mensagem":"Operação efetuada com sucesso",
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"dados_adicionais":
{
"Saldo":"500","Nome":"Jose da Silva",
}
}
GetProduto
Este método tem o propósito de retornar os produtos disponiveis para acumulo.
URL: http://fidelidade.chleba.net/ws/consumir.aspx
Método: GetProduto
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Cliente:
|
Parametro |
Tipo |
Info Adicional |
Obrigatório |
|
EmpresaGuid |
string |
Sim |
Exemplo de chamada:
{
"produtoresgate":
{
"produtoresgatejson":{
"EmpresaGuid":" C26E28F2-0124-45FF-BB69-A5B0CDB465C5"
}
}
}
Dados do retorno:
|
Informação |
Tipo |
Info Adicional |
|
SKU |
varchar(50) |
|
|
Descricao |
Varchar(100) |
|
|
Pontos |
int |
|
Exemplo de retorno:
[{"SKU":"0001","Descricao":"Cadastro","Pontos":0},
{"SKU":"0002","Descricao":"Macarrão","Pontos":500},
{"SKU":"0003","Descricao":"Guarana","Pontos":300}]