Exibir origem

Shopping - Linx Microvix > Widget - Compromissos do Dia > Esse conteúdo te ajudou_! (1).png

Linkar a âncora!

Token de Cadastro/Autenticação

URL de homologação: https://hubagnostico-homologacao.linx.com.br/v1

URL de produção:

Parâmetros do header:

Parâmetro	Tipo	Valor
Linx-Cnpj	String	CNPJ do cliente
Linx-TokenProduto	String	Token do produto (Microvix, Seta)
Linx-TokenParceiro	String	Token do parceiro (Dito, Open Cashback)
Linx-IdParceiro	String	ID do parceiro (Obtido no endpoint de parceiros)

Segue abaixo a lista de endpoints da API:

Para autenticação exclusiva deste endpoint, é necessário apenas o token do produto.

Endereço: Configuracao/BuscarParceiros

Parâmetro	Tipo	Valor
Linx-TokenProduto	String	Token do produto (Microvix, Seta)

{}

{
  [
    "Id": 0,
    "Descricao": "string"
  ]
}

Parâmetro	Tipo	Valor	Obrigatoriedade
Id	Inteiro	Código de identificação do parceiro	Obrigatório
Descricao	String	Nome do parceiro	Obrigatório

{
  "IdentificadorTransacao": "string",
  "Nome": "string",
  "RG": "string",
  "CPF": "string",
  "EstadoCivil": 1,
  "DataNascimento": "2024-12-12T12:52:57.111Z",
  "Sexo": 0,
  "Profissao": "string",
  "NomeMae": "string",
  "NomePai": "string",
  "NomeConjuge": "string",
  "Naturalidade": "string",
  "Escolariedade": 0,
  "RendaMensal": 0,
  "NumeroDependentes": 0,
  "LocalDeTrabalho": "string",
  "TempoNoAtualEmprego": "string",
  "Endereco": {
    "Cep": "string",
    "Logradouro": "string",
    "Numero": "string",
    "Complemento": "string",
    "Bairro": "string",
    "Cidade": "string",
    "UF": "string",
    "Pais": "string"
  },
  "Contato": {
    "Telefone": "string",
    "Celular": "string",
    "Email": "string"
  }
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Nome	String
RG	String
CPF	String
EstadoCivil	Inteiro	NaoInformado = 1, Casado = 2, Solteiro = 3, Divorciado = 4, Viuvo = 5, Outros = 6, Concubinato = 7
DataNascimento	String
Sexo	Inteiro	NaoInformado = 0, Masculino = 1, Feminino = 2
Profissao	String
NomeMae	String
NomePai	String
NomeConjuge	String
Naturalidade	String
Escolariedade	Inteiro	NaoInformado = 0, EnsinoFundamentalIncompleto = 1, EnsinoFundamentalCompleto = 2, EnsinoMedioCompleto = 3, GraduacaoCompleto = 4, PosGraduacaoCompleto = 5
RendaMensal	Decimal
NumeroDependentes	Inteiro
LocalDeTrabalho	String
TempoNoAtualEmprego	String
Cep	String
Logradouro	String
Numero	String
Complemento	String
Bairro	String
Cidade	String
UF	String
Pais	String
Telefone	String
Celular	String
Email	String

{
  "IdentificadorTransacao": "string",
  "SaldoAtual": 0,
  "SaldoDisponivel": 0,
  "UtilizaPin": true,
  "TipoPin": 1,
  "ClienteCadastrado": true
}

Parâmetro	Tipo	Valor	Obrigatoriedade
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
SaldoAtual	Decimal		Obrigatório
SaldoDisponivel	Decimal		Obrigatório
UtilizaPin	Booleano		Obrigatório
TipoPin	Inteiro	Celular = 1, Email = 2
ClienteCadastrado	Booleano

{ 
  "IdentificadorTransacao": "string",
  "Venda": {
    "Cpf": "string",
    "Vendedor": {
      "Id": 0,
      "Nome": "string"
    },
    "DataHora": "2024-12-12T12:56:54.891Z",
    "ValorLiquido": 0,
    "ValorBruto": 0,   
    "DescontoTotalValor": 0,
	"QuantidadeTotalItens": 0,   
    "Itens": [
      {
        "ValorAcrescimo": 0,
        "ValorUnitario": 0,
        "Ordem": 0,
        "Codigo": 0,
        "Ean": "string",
        "Produto": "string",
        "QuantidadeTotal": 0,
        "ValorLiquido": 0,
        "ValorBruto": 0,
        "ValorDesconto": 0
      }
    ]
  }
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Cpf	String
Id	Inteiro
Nome	String
DataHora	String
ValorLiquido	Decimal
ValorBruto	Decimal
DescontoTotalValor	Decimal
QuantidadeTotalItens	Inteiro
ValorAcrescimo	Decimal
ValorUnitario	Decimal
Ordem	Inteiro
Codigo	Inteiro
Ean	String
Produto	String
QuantidadeTotal	Inteiro
ValorLiquido	Decimal
ValorBruto	Decimal
ValorDesconto	Decimal

{
  "IdentificadorTransacao": "string",
  "SaldoAtual": 0,
  "SaldoDisponivel": 0,
  "UtilizaPin": true,
  "TipoPin": 1,
}

Parâmetro	Tipo	Valor	Obrigatoriedade
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
SaldoAtual	Decimal		Obrigatório
SaldoDisponivel	Decimal		Obrigatório
UtilizaPin	Booleano		Obrigatório
TipoPin	Inteiro	Celular = 1, Email = 2

{
  "IdentificadorTransacao": "string",
  "Celular": "string",
  "Email": "string",
  "Cpf": "string",
  "TipoPin": 1
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Celular	String
Email	String
Cpf	String
TipoPin	Inteiro	Celular = 1, Email = 2

{
  "IdentificadorTransacao": "string"
}

{
  "IdentificadorTransacao": "string",
  "Cpf": "string",
  "Pin": "string"
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Cpf	String
Pin	String

{
  "IdentificadorTransacao": "string",
  "PinValido": true,
}

Parâmetro	Tipo	Valor	Obrigatoriedade
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
PinValido	Booleano		Obrigatório

{ 
  "IdentificadorTransacao": "string",
  "Venda": {
    "ValorLiquido": 0,
    "ValorBruto": 0,
    "ValorAcrescimo": 0,
    "DescontoTotalValor": 0,
    "ValorResgate": 0,
    "CupomDesconto": "string",
	"QuantidadeTotalItens": 0,     
    "FormasDePagamento": [
      {
        "Id": 1,
        "ValorPago": 0
      }
    ],     
    "Cpf": "string",
    "Vendedor": {
      "Id": 0,
      "Nome": "string"
    },
    "DataHora": "2024-12-12T12:55:46.129Z",
    "Itens": [
      {
        "Ordem": 0,
        "Codigo": 0,
        "Ean": "string",
        "Produto": "string",
        "QuantidadeTotal": 0,
        "ValorLiquido": 0,
        "ValorBruto": 0,
        "ValorDesconto": 0,
        "ValorAcrescimo": 0,
        "ValorUnitario": 0       
      }
    ]
  }
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
ValorLiquido	Decimal
ValorBruto	Decimal
ValorAcrescimo	Decimal
DescontoTotalValor	Decimal
ValorResgate	Decimal
CupomDesconto	String
QuantidadeTotalItens	Inteiro
FormasPagamento	Inteiro
Cpf	Inteiro
Id	Inteiro
Nome	String
DataHora	String
Ordem	Inteiro
Codigo	Inteiro
Ean	String
Produto	String
QuantidadeTotal	Inteiro
ValorLiquido	Decimal
ValorBruto	Decimal
ValorDesconto	Decimal

Em relação ao parâmetro FormasPagamento, há diversas configurações de atributos disponíveis para utilização, contendo um número e uma descrição. Os atributos referentes a esse parâmetro são:

Número	Descrição
01	Dinheiro
02	Cheque
03	Cartão de Crédito
04	Cartão de Débito
05	Cartão da Loja (Private Label), Crediário Digital, Outros Crediários
10	Vale Alimentação
11	Vale Refeição
12	Vale Presente
13	Vale Combustível
14	Duplicata Mercantil
15	Boleto Bancário
16	Depósito Bancário
17	Pagamento Instantâneo (PIX) - Dinâmico
18	Transferência bancária, Carteira Digital
19	Programa de fidelidade, Cashback, Crédito Virtual
20	Pagamento Instantâneo (PIX) - Estático
21	Crédito em Loja
22	Pagamento Eletrônico não Informado - falha de hardware do sistema emissor
90	Sem Pagamento
99	Outros

{
  "IdentificadorTransacao": "string",
  "Campanhas": [
    {
      "Id": 0,
      "Descricao": "string",
      "TextoComplementar": "string",
      "ValorDesconto": 0,
      "DataInicio": "2024-12-12T12:56:02.198Z",
      "DataFinal": "2024-12-12T12:56:02.198Z"
    }
  ],
  "HabilitaBotaoNaoBonificar": false
}

Parâmetro	Tipo	Valor	Obrigatoriedade
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Campanhas	Objeto		Obrigatório
HabilitaBotaoNaoBonificar	Booleano		Obrigatório

Caso não queira enviar campanhas, deixar propriedade vazia ([]).
Por padrão, a tela sempre será iniciada com a primeira campanha selecionada.
Conforme o valor enviado na propridade 'HabilitaBotaoNaoBonificar', na tela ficará disponível o botão "Não Bonificar" (localizado ao lado do botão "Finalizar").
- Portanto se o valor enviado for:
  - Verdadeiro (true): O vendedor poderá decidir se irá bonificar ou não.
  - Falso (false): Se houver campanhas, o vendedor sempre irá escolher uma campanha obrigatoriamente.
As propriedades abaixo só serão obrigatórias se "Campanhas" não for vazio.

- Parâmetro Tipo Valor Obrigatoriedade
  Id Inteiro
  Obrigatório
  Descricao String
  Obrigatório
  ValorDesconto Decimal
  Obrigatório
  DataInicio String
  Obrigatório
  DataFinal String
  Obrigatório
  TextoComplementar String

{
  "IdentificadorTransacao": "string",
  "Cpf": "string",
  "VendaValorLiquido": 0,
  "ValorResgatado": 0
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Cpf	String
VendaValorLiquido	Decimal
ValorResgatado	Decimal

{
  "IdentificadorTransacao": "string"
}

A propriedade "VendaValorLiquido" refere-se ao total líquido da venda, o mesmo enviado nas rotas "ConsultarCampanha" e "GerarBonus" no objeto "Venda", na propriedade "ValorLiquido"

Esta rota sempre será executada no fluxo de venda do Hub, mesmo que não tenha sido gerado bônus.

{
  "IdentificadorTransacao": "string",
  "Venda": {
    "Cpf": "string",
    "Vendedor": {
      "Id": 0,
      "Nome": "string"
    },
    "DataHora": "2024-12-12T12:56:54.891Z",
    "ValorLiquido": 0,
    "ValorBruto": 0,
    "DocumentoNF": "string",
    "SerieNF": "string",
    "DescontoTotalValor": 0,
    "ValorResgate": 0,
    "CupomDesconto": "string",
	"QuantidadeTotalItens": 0,      
    "FormasDePagamento": [
      {
        "Id": 1,
        "ValorPago": 0
      }
    ],          
    "Itens": [
      {
        "ValorAcrescimo": 0,
        "ValorUnitario": 0,
        "Ordem": 0,
        "Codigo": 0,
        "Ean": "string",
        "Produto": "string",
        "QuantidadeTotal": 0,
        "ValorLiquido": 0,
        "ValorBruto": 0,
        "ValorDesconto": 0
      }
    ]
  },
  "CampanhaId": 0
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Cpf	String
Id	Inteiro
Nome	String
DataHora	String
ValorLiquido	Decimal
ValorBruto	Decimal
DocumentoNF	String
SerieNF	String
DescontoTotalValor	Decimal
ValorResgate	Decimal
CupomDesconto	String
QuantidadeTotalItens	Inteiro
FormasPagamento	Inteiro
ValorAcrescimo	Decimal
ValorUnitario	Decimal
Ordem	Inteiro
Codigo	Inteiro
Ean	String
Produto	String
QuantidadeTotal	Inteiro
ValorLiquido	Decimal
ValorBruto	Decimal
ValorDesconto	Decimal
CampanhaId	Inteiro	Este campo poderá ser nulo

Em relação ao parâmetro FormasPagamento, há diversas configurações de atributos disponíveis para utilização, contendo um número e uma descrição. Os atributos referentes a esse parâmetro são:

Número	Descrição
01	Dinheiro
02	Cheque
03	Cartão de Crédito
04	Cartão de Débito
05	Cartão da Loja (Private Label), Crediário Digital, Outros Crediários
10	Vale Alimentação
11	Vale Refeição
12	Vale Presente
13	Vale Combustível
14	Duplicata Mercantil
15	Boleto Bancário
16	Depósito Bancário
17	Pagamento Instantâneo (PIX) - Dinâmico
18	Transferência bancária, Carteira Digital
19	Programa de fidelidade, Cashback, Crédito Virtual
20	Pagamento Instantâneo (PIX) - Estático
21	Crédito em Loja
22	Pagamento Eletrônico não Informado - falha de hardware do sistema emissor
90	Sem Pagamento
99	Outros

{
  "IdentificadorTransacao": "string",
  "SaldoBonusGeradoVenda": 0,
  "SaldoBonusAtual": 0,
   "MensagemComplementar": "string"
 }

Parâmetro	Tipo	Valor	Obrigatoriedade
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
SaldoBonusGeradoVenda	Decimal		Obrigatório
SaldoBonusAtual	Decimal		Obrigatório
MensagemComplementar	String

Em caso de não haver bonificação na venda, o retorno dos parâmetros "SaldoBonusGeradoVenda" e "SaldoBonusAtual", o retorno do valor deverá ser 0. Portanto, irá retornar o response, contudo com as propriedades citadas zeradas.

{
  "IdentificadorTransacao": "string", 
  "DocumentoNF": "string",
  "SerieNF": "string",
  "Cpf": "string"
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
DocumentoNF	String
SerieNF	String
Cpf	String

{
  "IdentificadorTransacao": "string",
  "ValorEstornadoUtilizado": 0,
  "ValorEstornadoGerado": 0, 
  "SaldoBonusAtual": 0,
  "MensagemComplementar": "string",
  "DataHora": "2024-12-12T12:56:33.328Z"
}

Parâmetro	Tipo	Valor	Obrigatoriedade
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
ValorEstornadoUtilizado	Decimal		Obrigatório
ValorEstornadoGerado	Decimal		Obrigatório
SaldoBonusAtual	Decimal		Obrigatório
MensagemComplementar	String
DataHora	String		Obrigatório

Para todas as rotas da API, ao retornar um erro de regra de negócio (HTTP 400 - Bad Request), a resposta deve seguir a estrutura abaixo:

{
  "IdentificadorTransacao": "string",
  "Codigo": 0,
  "Mensagem": "string"
}

Parâmetro	Tipo	Valor
IdentificadorTransacao	String	GUID único para rastreamento da transação. Exemplo: 3F2504E0-4F89-41D3-9A0C-0305E82C3301
Código	String
Mensagem	String

Objetivo

A controller VendasMock foi criada para simular os endpoints de comunicação externa, permitindo que o time de QA realize testes sem dependência de integrações reais com sistemas de parceiros. Ela reproduz os mesmos métodos da comunicação real, porém retorna dados mockados.

Endpoints

Cada endpoint da VendasMock representa uma operação de venda (ex: AtualizarCliente, ConsultarSaldoCliente, etc), e retorna dados mockados com estrutura semelhante à da comunicação externa.

Request (opcional): Representa os dados enviados na chamada simulada ao sistema externo.
Response (opcional): Simula o retorno da comunicação externa.
Header (opcional): Simula os headers utilizados na comunicação, como:
- Cnpj
- TokenProduto
- TokenParceiro
- IdParceiro

Exemplo de estrutura de response para o endpoint AtualizarCliente:

{
	"Request": "string", 
    "Response": "string", 
    "Header": "string", 
    "SaldoAtual": 0,
    "SaldoDisponivel": 0,
    "UtilizaPin": true, 
    "TipoPin": 0, 
    "ClienteCadastrado": true
}

Para realizar um mock válido, basta preencher os campos:

{
   "SaldoAtual": 0,
   "SaldoDisponivel": 0, 
   "UtilizaPin": true, 
   "TipoPin": 0, 
   "ClienteCadastrado": true
}

Estrutura de Armazenamento

Os dados mockados são armazenados em duas tabelas:

arquivo_blob

Armazena o contexto geral da simulação (como se fosse uma "venda"). Campos:

id_arquivo_blob
identificador_operacao

arquivo_blob_item

Armazena os "passos" ou etapas da venda (cada chamada de endpoint mock). Campos principais:

id_arquivo_blob_item_tipo: define o tipo de operação mockada (ex: Mock AtualizaCliente)
url: link do JSON
descricao: nome (ex: "Atualizar Cliente.json")

Importante:
O sistema sempre considera o primeiro registro da tabela arquivo_blob para agrupar os mocks da simulação.
Se já existir um mock (registro em arquivo_blob_item) para aquele endpoint, será feito um update.
Se não existir, será feito um insert.

Forçar Tipo de Retorno (tipoRetornoMock)

Importante: O valor informado no parâmetro tipoRetornoMock nesta controller (VendasMock) será refletido posteriormente na controller real de Venda. Aqui, ele apenas registra e armazena essa informação para posterior uso, não executando diretamente o fluxo final.

Nos endpoints da controller VendasMock, é possível forçar um tipo específico de retorno usando o parâmetro tipoRetornoMock na query string:

Valor	Significado
0	Sucesso (default)
1	Erro de Exceção
2	Erro de Validação

Obs.: O tipo 0 (sucesso) só será retornado se todo o fluxo estiver completo. Os demais tipos simulam falhas específicas.

Tipos de Mock Suportados

Utilizamos apenas os tipos de arquivo_blob_item_tipo relacionados a mocks.

Exemplos:

ID	Descrição
11	Mock AtualizaCliente
12	Mock ConsultaSaldoCliente
13	Mock SolicitaPin
14	Mock ValidaPin
15	Mock ConsultarCampanha
16	Mock ValidarBonus
17	Mock GerarBonus
18	Mock EstornarBonus

Considerações Finais

O processo de simulação permite rastrear todos os passos da comunicação, com histórico armazenado no banco.

Os arquivos são salvos em blob storage, e a URL pode ser consultada na coluna url da tabela arquivo_blob_item.