Este tópico trata das API's que possuímos atualmente e também documenta todas elas.
API de Integrações Linx
LINK: HTTPS://LX-DEGUST-API-INTEGRACAO-HMG.AZUREWEBSITES.NET/SWAGGER/INDEX.HTML
Essa API tem como função dispor rotas para que os parceiros realizem a extração de seus respectivos dados, obtidos através do sistema Degust.
Todos os terminais abaixo devem ser colocados após o link (lx-degust-api-integracao-hmg.azurewebsites.net).
Exemplo: lx-degust-api-integracao-hmg.azurewebsites.net/api/{Nome do Metodo}/{Nome do Metodo}
 IMPORTANTE: É necessário autorização para ter acesso aos links abaixo. Para Obter a autenticação de usuário é necessário acessar o terminal Usuário abaixo. |
|---|
API de Integrações Linx | Caminho | Função |
|---|---|---|
| Usuário | /api/usuario/autenticar | Realiza a autenticação do usuário na API. |
| Caixa | /api/caixa/dados-fechamento | Consulta informações sobre o fechamento de caixa. |
| Conta Cliente | /api/conta-cliente/vendas | Consulta informações sobre as vendas vinculados a conta do cliente. |
| Dotz (Configuração) | /api/dotz/configuracao | Faz a configuração de produtos vinculados ao Dotz. |
| Dotz (Tabela) | /api/dotz/tabela-pontos/{tabelaPontos}/produto | Faz a configuração do tabelamento de produtos vinculados ao Dotz. |
| Nota Fiscal | /api/nota-fiscal/dados-nf | Consulta informações da nota fiscal retorna cabeçalho e item. |
| Pedido Compra | /api/pedido-compra/dados | Consulta informações do pedido de compra e itens. |
| Produto (Inventário) | /api/produto/inventario | Consulta informações sobre o inventário de produtos. |
| Produto (Exportação) | /api/produto/exportacao-dados-produto | Consulta a exportação e informações de produtos. |
API Degust v.2.0
LINK: http://degust.com.br/api/APIDegust/
O objetivo desta API é disponibilizar os dados detalhados de venda (cupom a cupom), bem como, os dados de tabelas auxiliares (loja, produto, forma de pagamento, etc.) que complementam as informações de venda. Geralmente os dados retornados pela API são utilizados para integração com sistemas de ERP e/ou BI.
Todos os terminais abaixo devem ser colocados após o link (http://degust.com.br/api/APIDegust/).
Exemplo: http://degust.com.br/api/APIDegust/vX/{Nome do Metodo}
|
|---|
API Degust v.2.0 | Caminho | Função |
|---|---|---|
TOKEN | /api/APIDegust/token | Realiza a autenticação do usuário na API. |
Loja | /api/APIDegust/V1/LOJA | Para receber o cadastro de Lojas de determinado Franqueador. |
Produto | /api/APIDegust/V1/PRODUTO | Para receber o cadastro de todos os Produtos de determinado Franqueador. |
Formas de Pagamento | /api/APIDegust/V1/FORMASPAGAMENTO | Para receber o cadastro das Formas de pagamento de determinado Franqueador. |
Cadastro de Tipo de Venda | /api/APIDegust/V1/TIPOSVENDA | Para receber o cadastro de Tipos de Venda de determinado Franqueador. |
Vendas | /api/APIDegust/V1/VENDAS | Para receber os dados de vendas de determinada loja e data. |
Vendas V2 | /api/APIDegust/V2/VENDAS | Para receber os dados de venda de determinada loja e data. |
API Hub Delivery
LINK: degust.com.br/api/Delivery2/api/v2/
O objetivo desta API é facilitar a consulta e a manutenção de lojas incluídas no HUB Delivery.
Todos os terminais abaixo devem ser colocados após o link (degust.com.br/api/Delivery2/api/v2/).
Exemplo: degust.com.br/api/Delivery2/api/vX/{Nome do Metodo}
API Hub Delivery | Caminho | Função |
|---|---|---|
PARCEIRO | ||
Consultar Parceiros | /api/Delivery2/api/v1/Parceiro/ConsutarParceiros | Realiza a consulta dos parceiros integrados no HUB Delivery. |
Consulta Parceiro CNPJ | /api/Delivery2/api/v1/Parceiro/ConsultaParceiroCnpj | Realiza a consulta do parceiro requerido pelo numero de CNPJ. |
Consulta Parceiro Nome | /api/Delivery2/api/v1/Parceiro/ConsultaParceiroNome | Realiza a consulta do parceiro requerido pelo nome. |
Cadastrar Parceiro | /api/Delivery2/api/v1/Parceiro/CadastrarParceiro | Cadastra um novo parceiro no HUB Delivery. |
Atualizar Dados Parceiro | /api/Delivery2/api/v1/Parceiro/AtualizarDadosParceiro | Realiza a atualização de dados do parceiro. |
Consulta Parceiro Codigo Pdv | /api/Delivery2/api/v1/Parceiro/ConsultaParceiroCodigoPdv | Consulta o código do parceiro dentro do PDV do cliente. |
Deletar Parceiro | /api/Delivery2/api/v1/Parceiro/DeletarParceiro | Deleta o parceiro do HUB Delivery. |
LOJA | ||
Consultar Lojas | /api/Delivery2/api/v1/Loja/ConsultarLojas | Realiza a consulta das Lojas integradas no HUB Delivery. |
Consultar Loja ID | /api/Delivery2/api/v1/Loja/ConsultarLojaId | Realiza a consulta de Lojas pelo ID fornecido. |
Consultar Lojas CNPJ | /api/Delivery2/api/v1/Loja/ConsultarLojaCnpj | Realiza a consulta das Lojas por numero de CNPJ. |
Cadastrar Loja | r/api/Delivery2/api/v1/Loja/CadastrarLoja | Cadastra uma nova loja no HUB Delivery |
Atualizar Dados Loja | /api/Delivery2/api/v1/Loja/AtualizarDadosLoja/4 | Realiza a atualização de dados da Loja. |
Deletar Loja | /api/Delivery2/api/v1/Loja/DeletarLoja | Deleta a Loja do HUB Delivery. |
PARCEIRO LOJA | ||
Vincular Parceiro Loja | /api/Delivery2/api/v1/Parcloja/Vincular | Faz o vínculo de um Parceiro com uma Loja do HUB Delivery. |
Vincular Mapeamento Rappi | /api/Delivery2/api/v1/Parcloja/VincularProduto | Faz o vínculo do Mapeamento da Rappi com a Loja. |
Consultar Mapeamento rappi_id | /api/Delivery2/api/v1/Parcloja/ConsultarRappiId | Consulta o status do Mapeamento Rappi da Loja. |
Consultar Mapeamento sku_degust | /api/Delivery2/api/v1/Parcloja/ConsultarSkuDegust | Consulta o status do Mapeamento Sku Degust. |
Consultar Loja | /api/Delivery2/api/v1/Parcloja/ConsultarLoja | Consulta a Loja vinculada pelo ID ou pelo CNPJ. |
Consultar Parceiro | /api/Delivery2/api/v1/Parcloja/ConsultarParceiro | Consulta o Parceiro pelo CNPJ. |
Alternar Status | /api/Delivery2/api/v1/Parcloja/AlterarStatus | Alterna status de vínculo Parceiro Loja para ativo ou inativo. |
Deletar Vinculo | degust.com.br/api/Delivery2/api/v1/Parcloja/DeletarVinculo | Deleta o vínculo entre Parceiro e Loja. |
FATURAMENTO | ||
Token | /api/Delivery2/token | Libera o acesso ao HUB Delivery. |
Detalhe do Pedido | /api/Delivery2/api/v2/Pedido/ConsultarDetalhePedido | Detalha o Pedido pelo ID fornecido. |
Lote de Pedido | /api/Delivery2/api/v1/Pedido/ConsultarLotePedido | Realiza a consulta dos Lotes de Pedidos. |
Incluir Pedido | /api/delivery2/api/v1/Pedido/IncluirPedido | Faz a inclusão de Pedidos pelo HUB Delivery. |
Status Loja | /api/Delivery2/api/v1/Loja/ConsultarStatus | Verifica o Status da Loja e do vínculo Parceiro Loja. |
Aceitar Pedido | /api/Delivery2/api/v1/Pedido/AceitarPedido | Aceita o Pedido pelo HUB Delivery com o ID e CNPJ fornecidos. |
Produzir Pedido | /api/Delivery2/api/v1/Pedido/ProduzirPedido | Coloca o Pedido em fase de Produção pelo HUB Delivery. |
Separar Pedido | /api/Delivery2/api/v1/Pedido/SepararPedido | Coloca o Pedido em fase de Separação pelo HUB Delivery. |
Entregar Pedido | /api/Delivery2/api/v1/Pedido/EntregarPedido | Coloca o Pedido em fase de Entrega pelo HUB Delivery. |
Receber Pedido | /api/Delivery2/api/v1/Pedido/ReceberPedido | Coloca o Pedido em fase de Recebimento pelo HUB Delivery. |
Cancelar Pedido | /api/Delivery2/api/v1/Pedido/CancelarPedido | Realiza o cancelamento do pedido pelo HUB Delivery. |
Marcar Como Cancelado | /api/Delivery2/api/v2/Pedido/MarcarComoCancelado | Pelo HUB Delivery marca o pedido como cancelado . |
API Cash Monitor
Documentação Swagger: Integração LINX API (lx-degust-api-integracao-prd.azurewebsites.net)
API de integração do Degust para o conciliador conciliador CashMonitor.
Endpoint Cash Monitor: GET /api/cash-monitor
Campo | Descrição | API Degust CashMonitor |
|---|---|---|
Campo | Descrição | API Degust CashMonitor |
| acquirerId | Código referente a cada adquirente, sendo:
| De/Para de acordo com o cadastro de receitas da Retaguarda, campo "Credenciador". Obs> Caso não seja encontrado correspondência, será enviado o valor 99
|
| transactionType | Código referente a cada transação, sendo:
| De/Para conforme campo "Tipo Eletrônico" configurado no cadastro de receitas do Degust, com as seguintes opções:
|
| transactionDate | Data em que foi realizada a transação | Data da transação do TEF (VendaFinaTef.DataVenda) |
| grossAmount | Valor correspondente da transação | Valor total da transação (VendaFinalTef.VFT_Valor) |
| autorization | Valor correspondente da autorização | Autorização da transação (VendaFinalTef.VFT_Autorizacao) |
| nsu | Número da NSU | NSU da transação (VendaFinalTef.VFT_Nsu) |
| establishment | Nome do estabelecimento | Nome da loja |
| cardNumber | Número do cartão | Número do cartão parcial, conforme retornado pelo TEF (4 primeiros ou 4 últimos dígitos do cartão) - se retornando pelo TEF (VendaFinalTef.VFT_UltimosQuatroDigitos) |
| cardBrand | Bandeira do Cartão | Nome da receita conforme configurado no cadastro de receitas do Degust (ReceitaCaixa.DesReceita)
|
| totalInstallments | Total de Parcelas | Quantidade de parcelas da transação (quando não houver parcelas será retornado 0) |
| orderCode | Código do Pedido | Retorna o número de controle da venda na Retaguarda (Venda.Ven_ControleSite) |
Share completo sobre esta API: [Benjamim a Padaria] API CashMonitor (Entrega)
API de Exportação de Vendas
API de integração do DegustWeb para o PDV.
Endpoint API de Exportação de Vendas: /api/ConfigPDV
|
|---|
API de Exportação de Vendas | Caminho | Função |
|---|---|---|
TOKEN | /api/ConfigPDV/token | Realiza a autenticação do usuário na API. |
Loja | /api/ConfigPDV | Envia as informações do DegustWeb para o PDV. |
Esse documento foi criado no dia e deverá ser atualizado com frequência para melhor compreensão das API's. Ultima atualização: . |
|---|