INTRODUÇÃO
Objetivo
A integração com o sistema de CashBack Money visa estabelecer a comunicação entre os diversos parceiros e o programa de Cashback.
Plataforma
Os serviços são expostos via API acessíveis 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 cashback.
Interface da API
Os seguintes métodos são expostos nos webservices da Integração:
- PostCliente
- PostExtrato
- PostOperacaoPreview
- PostOperacao
- PostReserva
- PostEstorno
- GetSaldo
ACESSO A API DE INTEGRAÇÃO
Ao ser registrado um novo parceiro no sistema CashBack, 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.
MÉTODOS DA API
PostCliente
Este método tem o propósito incluir/alterar cliente na base de dados do cashback:
URL: https://developers.addsuite.com.br/ws/consumir.aspx
Método: PostCliente
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
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": "71E5C6DB-FF57-456E-8786-869841027524",
"Nome": "Ricardo Teste",
"ClienteCPF": "65203675853",
"ClienteNome": "Ricardo Teste",
"email": "[email protected]",
"DataNasc": "24/04/1999",
"Sexo": "U",
"CelDdd": "51",
"Cel": "988087854",
"TelDdd": "51",
"Telefone": "988087854",
"Cep": "99700252",
"Endereco": "Rua Pedro Alvares Cabral",
"Numero": "999",
"Complemento": "",
"UF": "RS",
"Cidade": "Erechim",
"Bairro": "Centro"
}
}
}
Retorno
{
"codigo": 0,
"mensagem": "Operação efetuada com sucesso",
"ticket": "c60cdb68-fa0b-4d55-9579-e4498d03babd",
"dados_adicionais": null
}
Retorno erro
{
"codigo": 0,
"mensagem": "Operação efetuada com sucesso",
"ticket": "c60cdb68-fa0b-4d55-9579-e4498d03babd",
"dados_adicionais": null
}
PostOperacaoPreview
Usado para simular uma reserva ou enviar um pedido direto sem reserva.
URL: https://developers.addsuite.com.br/ws/consumir.aspx
Método: PostOperacaoPreview
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
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) |
|
|
pinNumber |
varchar(10) |
|
|
Nome_cupom |
varchar(100) |
|
|
Nome_grupo |
varchar(100) |
|
|
Data |
datetime |
|
|
LojaID |
int |
|
|
NumeroPedido |
varchar(200) |
|
|
ValorBruto |
Decimal (18,2) |
|
|
ValorPedido |
Decimal (18,2) |
|
|
ValorResgate |
Decimal (18,2) |
|
|
EmpresaGuid |
Varchar(36) |
|
|
Pdv |
Varchar(100) |
|
|
OperadorCode |
Varchar(100) |
|
|
NotaFiscalNumero |
Varchar(100) |
|
|
NotaFiscalTimeSpan |
Varchar(100) |
|
|
OrigemVenda |
Varchar(50) |
|
Dados do itens:
|
Informação |
Tipo |
Info Adicional |
|
ProdutoNome |
varchar(5000) |
|
|
ProdutoSKU |
varchar(200) |
|
|
Valor |
Decimal(18,2) |
|
|
Quantidade |
Decimal (18,2) |
|
|
TipoOperacao |
varchar (1) |
C=Credito/D=Debito |
Envio
{
"PostOperacao": {
"Operacao": {
"ClienteCPF": "58211515385",
"pinNumber": "7788",
"Data": "10/04/2023 15:59",
"LojaID": "1010",
"NumeroPedido": "",
"ValorPedido": "10.00",
"Desconto": "0.00",
"EmpresaGuid": "40C99A6D-4EFA-4516-9B38-F7BF9E51A924",
"PDV": "0",
"OperadorCode": "CAIXA",
"NotaFiscalNumero": "0",
"OrigemVenda": "SITE",
"Nome_cupom" : "",
"Nome_grupo" : "",
"OperacaoItem": [
{
"ProdutoNome": "PALIO",
"ProdutoSKU": "PALIO-3-0002",
"Valor": "10.00",
"Quantidade": "1.00",
"TipoOperacao": "C"
}
]
}
}
}
PostOperacao
Usado para confirmar uma reserva ou enviar um pedido direto sem reserva.
URL: https://developers.addsuite.com.br/ws/consumir.aspx
Método: PostOperacao
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
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) |
|
|
pinNumber |
varchar(10) |
|
|
Nome_cupom |
varchar(100) |
|
|
Nome_grupo |
varchar(100) |
|
|
Data |
datetime |
|
|
LojaID |
int |
|
|
NumeroPedido |
varchar(200) |
|
|
ValorBruto |
Decimal (18,2) |
|
|
ValorPedido |
Decimal (18,2) |
|
|
ValorResgate |
Decimal (18,2) |
|
|
EmpresaGuid |
Varchar(36) |
|
|
Pdv |
Varchar(100) |
|
|
OperadorCode |
Varchar(100) |
|
|
NotaFiscalNumero |
Varchar(100) |
|
|
NotaFiscalTimeSpan |
Varchar(100) |
|
|
OrigemVenda |
Varchar(50) |
|
Dados do itens:
|
Informação |
Tipo |
Info Adicional |
|
ProdutoNome |
varchar(5000) |
|
|
ProdutoSKU |
varchar(200) |
|
|
Valor |
Decimal(18,2) |
|
|
Quantidade |
Decimal (18,2) |
|
|
TipoOperacao |
varchar (1) |
C=Credito/D=Debito |
Envio
{
"PostOperacao": {
"Operacao": {
"ClienteCPF": "54644282677",
"pinNumber": "7788",
"Data": "15/05/2023 19:50",
"LojaID": "1010",
"NumeroPedido": "22800010",
"ValorPedido": "10.00",
"Desconto": "0.00",
"EmpresaGuid": "40C99A6D-4EFA-4516-9B38-F7BF9E51A924",
"PDV": "5084",
"OperadorCode": "CAIXA",
"NotaFiscalNumero": "78989",
"OrigemVenda": "SITE",
"Nome_cupom" : "",
"Nome_grupo" : "",
"OperacaoItem": [
{
"ProdutoNome": "PALIO",
"ProdutoSKU": "PALIO-3-0002",
"Valor": "10.00",
"Quantidade": "1.00",
"TipoOperacao": "C"
}
]
}
}
}
Retorno
{
"codigo": 0,
"mensagem": "Operação efetuada com sucesso",
"ticket": "872ca0bf-740a-46a7-ae12-4588e10ab633",
"dados_adicionais": null
}
Erro
{
"codigo": 7,
"mensagem": "Pedido já cadastrado",
"ticket": "caa21be7-ae24-4877-9cb2-dab04c5b3b3f",
"dados_adicionais": null
}
PostReserva
Este método tem o propósito incluir uma reserva.
URL: https://developers.addsuite.com.br/ws/consumir.aspx
Método: PostReserva
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
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) |
|
|
pinNumber |
varchar(10) |
|
|
Nome_cupom |
varchar(100) |
|
|
Nome_grupo |
varchar(100) |
|
|
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) |
|
|
OrigemVenda |
Varchar(50) |
|
Dados do itens:
|
Informação |
Tipo |
Info Adicional |
|
ProdutoNome |
varchar(5000) |
|
|
ProdutoSKU |
varchar(200) |
|
|
Valor |
Decimal(18,2) |
|
|
Quantidade |
Decimal (18,2) |
|
|
Desconto |
Decimal (18,2) |
|
|
TipoOperacao |
varchar (1) |
C=Credito/D=Debito |
Envio
{
"PostOperacao": {
"Operacao": {
"ClienteCPF": "54644282677",
"pinNumber": "7788",
"Data": "15/05/2023 19:50",
"LojaID": "1010",
"NumeroPedido": "22800010",
"ValorPedido": "10.00",
"Desconto": "0.00",
"EmpresaGuid": "40C99A6D-4EFA-4516-9B38-F7BF9E51A924",
"PDV": "5084",
"OperadorCode": "CAIXA",
"NotaFiscalNumero": "78989",
"OrigemVenda": "SITE",
"Nome_cupom" : "",
"Nome_grupo" : "",
"OperacaoItem": [
{
"ProdutoNome": "PALIO",
"ProdutoSKU": "PALIO-3-0002",
"Valor": "10.00",
"Quantidade": "1.00",
"TipoOperacao": "C"
}
]
}
}
}
Retorno
{
"codigo": 0,
"mensagem": "Operação efetuada com sucesso",
"ticket": "872ca0bf-740a-46a7-ae12-4588e10ab633",
"dados_adicionais": null
}
Retorno Erro
{
"codigo": 5,
"mensagem": "Campo requerido",
"ticket": "6b729307-43c3-46ad-858c-26444961091a",
"dados_adicionais": {
"mensagem": "CPF é obrigatório"
}
}
PostCancelarReserva
Este método tem o propósito de Cancelar uma determinada reserva.
Envio
{
"postcancelarseserva": {
"cancelareservajson": {
"EmpresaGuid": "71E5C6DB-FF57-456E-8786-869841027524",
"NumeroPedido": "121218",
"LojaID": "9999"
}
}
}
Retorno
{
"codigo": 0,
"mensagem": "Operação efetuada com sucesso",
"ticket": "be1839e7-a74a-4b03-a89c-cc983da89b5d",
"dados_adicionais": null
}
Erro
{
"codigo": 0,
"mensagem": "Pedido não localizado",
"ticket": "cb004cf2-acee-4611-8f0e-12e91a19c6ea",
"dados_adicionais": null
}
PostExtrato
Este método tem o propósito de retornar o extrato de pontos de um determinado cliente.
URL: https://developers.addsuite.com.br/ws/consumir.aspx
Método: PostExtrato
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
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": "40C99A6D-4EFA-4516-9B38-F7BF9E51A924",
"ClienteCPF": "54644282677",
"Dias": 90
}
}
}
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 |
|
Exemplo de retorno:
"TipoOperacao": "C" = Credito
"TipoOperacao": "D" = Débito
"TipoOperacao": "R" = Estornado ou reserva cancelada
{
"codigo": 0,
"mensagem": "Operação efetuada com sucesso",
"ticket": "6cb7e79c-358f-44c5-a096-c0d59bf549bc",
"dados_adicionais": [
{
"ClienteCPF": "63882757027",
"ClienteNome": "Angelo Teste",
"ClienteEmail": "[email protected]",
"Data": "02/02/2022 15:43:00",
"LojaID": "62",
"LojaNomeFantasia": "Chácara Santo Antônio",
"LojaRazaoSocial": "WCL Comércio de Alimentos Ltda - ME",
"NumeroPedido": "0041102O2RC",
"ValorPedido": 95.00,
"ValorBruto": 100.00,
"PDV": "0",
"OperadorCode": "0",
"NotaFiscalNumero": "0",
"ExtratoItens": [
{
"TipoOperacao": "C",
"CampanhaExpiracao": 90,
"CampanhaTitulo": "CashBack 10 %",
"ValorGerado": 9.50,
"DataExpiracao": "03/05/2022 23:59:59",
"DescricaoPersonalizada": ""
},
{
"TipoOperacao": "D",
"CampanhaExpiracao": 0,
"CampanhaTitulo": "Resgate Cashback",
"ValorGerado": 5.00,
"DataExpiracao": null,
"DescricaoPersonalizada": ""
}
]
},
{
"ClienteCPF": "63882757027",
"ClienteNome": "Angelo Teste",
"ClienteEmail": "[email protected]",
"Data": "01/02/2022 15:43:00",
"LojaID": "62",
"LojaNomeFantasia": "Chácara Santo Antônio",
"LojaRazaoSocial": "WCL Comércio de Alimentos Ltda - ME",
"NumeroPedido": "0041902O2RC",
"ValorPedido": 100.00,
"ValorBruto": 100.00,
"PDV": "0",
"OperadorCode": "0",
"NotaFiscalNumero": "0",
"ExtratoItens": [
{
"TipoOperacao": "C",
"CampanhaExpiracao": 90,
"CampanhaTitulo": "CashBack 10 %",
"ValorGerado": 10.00,
"DataExpiracao": "03/02/2022 23:59:59",
"DescricaoPersonalizada": ""
}
]
}
]
}
PostEstorno
Este método tem o propósito estornar pedido efetuado.
URL: https://developers.addsuite.com.br/ws/consumir.aspx
Método: PostEstorno
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Cliente:
|
Informação |
Tipo |
Info Adicional |
|
LojaID |
int |
|
|
NumeroPedido |
varchar(200) |
|
|
EmpresaGuid |
Varchar(36) |
|
Envio
{
"postestorno": {
"estorno": {
"EmpresaGuid": "71E5C6DB-FF57-456E-8786-869841027524",
"LojaID": "9999",
"NumeroPedido": "121221"
}
}
}
Retorno
{
"codigo": 0,
"mensagem": "Operação efetuada com sucesso",
"ticket": "be1839e7-a74a-4b03-a89c-cc983da89b5d",
"dados_adicionais": null
}
Retorno erro:
{
"codigo": 5,
"mensagem": "Campo requerido",
"ticket": "bb74f738-dc6c-4545-be6a-53e97a8723b5",
"dados_adicionais": {
"mensagem": "Loja ID é obrigatório"
}
}
{
"codigo": 8,
"mensagem": "Estorno não permitido, cashback já utilizado no pedido Número Pedido 2111646",
"ticket": "2f4cc552-ec4d-4cea-a7d6-daf03aeb51d2",
"dados_adicionais": null
}
GetSaldo
Este método tem o propósito de retornar o saldo de um determinado cliente.
URL: https://developers.addsuite.com.br/ws/consumir.aspx
Método: GetSaldo
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
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 |
Envio
{
"postsaldo": {
"saldojson": {
"EmpresaGuid": "40C99A6D-4EFA-4516-9B38-F7BF9E51A924",
"ClienteCPF": "54644282677"
}
}
}
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": "a34d29b7-3bcb-4e36-a482-a73105eb56ba",
"dados_adicionais": {
"Nome": "Jose Teste",
"Saldo": 35.00
}
}
Retorno erro:
{
"codigo": 5,
"mensagem": "Campo requerido",
"ticket": "5e2d61e1-f19a-46a1-a971-37075ec70921",
"dados_adicionais": {
"mensagem": "EmpresaGuid é obrigatório"
}
}