API - Extrator de Vendas - Integração Linx ERP e conciliador de cartões Equals

Visão Geral

A API de Extrator de Vendas do LinxERP para Envio ao Equals é uma funcionalidade que permite extrair as informações de vendas registradas no LinxERP e enviá-las para a plataforma Equals. Essa integração possibilita uma conciliação precisa e automatizada dos pagamentos realizados com cartões de crédito.

Sobre o Extrator de Vendas Linx

O extrator de vendas da Linx refere-se as vendas efetuadas dentro do ERP com suas respectivas informações que serão apresentadas abaixo, os dados desta extração.

Integração Linx Extrator de Vendas: Chamada API GraphQl

Para a utilização da API do Extrator de Vendas da Linx são utilizadas as seguintes variáveis de chamada (idEstabelecimentoERP, dataInicial, dataFinal, regerar e sistema).

Figura 1 – Exemplo do objeto Json de chamada

{
  "input": {
  "idEstabelecimentoERP": "000010",
  "dataInicial": "2019-01-01",
  "dataFinal": "2020-03-31",
  "regerar": false,
  "sistema": 1
  }
}

Figura 2 – Layout das Variáveis

Figura 3 – Exemplo Banana Cake POP, Banana Cake Web e Postman

Resposta da API

• A API retornará um código de status 200 (OK) em caso de sucesso, juntamente com um objeto JSON contendo as informações das vendas extraídas do LinxERP.
• Em caso de falha, a API retornará um código de status apropriado, juntamente com uma mensagem de erro descrevendo o motivo da falha.

Integração Linx Extrator de Vendas: Retorno API GraphQl

Para a utilização da API do Extrator de Vendas da Linx são utilizadas as seguintes query de retorno (nSR, iDEstabelecimentoERP, data, numeroUnicoERP, numeroUnicoNegocioLocalizado, nomeCliente, documentoCliente, observacaoVendas, informacaoAdicional1Venda, informacaoAdicional2Venda, flagCancelamento, iDTransacao, autorizacao, nSU, tID, documento, parcelas, iAdquirente, iDBandeira, iDFormaDePagamento, iDMeiodeCaptura, observacaoTransacao, informacaoAdicional1Pagamento,  informacaoAdicional2Pagamento, valor).

Figura 4 – Exemplo do objeto Json de retorno

mutation testeIntegration($input:
AddExtratorVendasCommandInput){
  addExtratorVendas(input: $input){
    vendas{
    nSR,
    iDEstabelecimentoERP,
    data,
    numeroUnicoERP,
    numeroUnicoNegocioLocalizado,
    nomeCliente,
    documentoCliente,
    observacaoVenda,
    informacaoAdicional1Venda,
    informacaoAdicional2Venda,
    flagCancelamento,
    iDTransacao,
    autorizacao,
    nSU,
    tID,
    documento,
    parcelas,
    iDAdquirente,
    iDBandeira,
    iDFormaDePagamento,
    iDMeioDeCaptura,
	observacaoTransacao,
    informacaoAdicional1Pagamento,
    informacaoAdicional2Pagamento,
    valor
    }
  }
}

Figura 5 – Layout da Query

Figura 6 – Exemplo Banana Cake POP, Banana Cake Web e Postman

Integração Linx Extrator de Vendas: Comunicação com a API

Para a utilização da API do Extrator de Vendas da Linx e sua integração são liberados dois endpoints, um apontado para um ambiente de desenvolvimento e outro para um ambiente de testes.

 Para os mesmos ambientes é disponibilizado o mesmo token, que seguem abaixo com os exemplos:

Ambiente DEV: https://dev-linx-erp-extrator-vendas.azurewebsites.net/graphql/

Figura 7 – Endereço da API de DEV nas ferramentas Banana Cake Pop e Postman

Ambiente QA: https://qa-linx-erp-extrator-vendas.azurewebsites.net/graphql/

Figura 8 – Endereço da API de QA nas ferramentas Banana Cake Pop e Postman

Autenticação: Para QA e DEv utilizar a autenticação do token Bearer, Chave única:

"Token": "f3413f64-3e3c-415b-a274-d417828ea2d9"

Figura 9 - Exemplo de autenticação via Banana Cake Pop, Bana Cake Web e Postman

Para o Postman você pode criar coleções para o seu teste assim como criar ambientes específicos para os testes exemplo: ambiente de desenvolvimento e ambiente de teste.

Figura 10 - Exemplo de Ambientes para testes

Resposta da API

• A API retornará um código de status 200 (OK) em caso de sucesso, juntamente com um objeto JSON contendo as informações das vendas extraídas do LinxERP.
• Em caso de falha, a API retornará um código de status apropriado, juntamente com uma mensagem de erro descrevendo o motivo da falha.