Azun Tecnologia AZUN API v2
Voltar ao Site Instalador PDV
Azun REST API v2.0 • Verificada no Backend Principal

Ecossistema de APIs & Serviços REST Azun

A plataforma Azun disponibiliza um conjunto abrangente de APIs RESTful estruturadas para conectar lojas virtuais, terminais de ponto de venda desktop em C++, totens de autoatendimento, cardápios digitais via QR Code, rastreadores de motoboys e motores fiscais da SEFAZ estadual.

Servidor Base Principal
https://backcore.azun.com.br/api
Gateway unificado do ERP & PDV
Formato Padrão
JSON (application/json)
Respostas tipadas e seguras
Ambientes
Produção & Sandbox
Header x-sandbox: true

Autenticação e Cabeçalhos Obrigatórios

O backend da Azun opera em três camadas claras de acesso:

1. APIs Livres & Abertas (Sem Chave)

Endpoints de consulta de saúde, catálogo aberto para e-commerce, links de autoatendimento de mesas e rotas do motoboy. Não exigem x-api-key nem Token de Administrador. Para lojas específicas no multi-tenant, basta enviar o cabeçalho x-tenant-id ou o subdomínio da loja.

2. API de Integração Externa (x-api-key)

As rotas /api/v1/* e /api/v2/* exigem a chave de API cadastrada no painel da loja enviada no cabeçalho x-api-key. Suportam chaves de produção (sk_live_...) e chaves de teste (sk_test_...).

3. APIs de Caixa PDV & Serviços Fiscais (Token de Caixa)

Os executáveis locais (AzunPDV.exe e AzunService.exe) utilizam tokens de caixa individuais (token=CX-XXXX-XXXX) vinculados ao terminal e série fiscal correspondente.

# Exemplo de Cabeçalhos para API Pública com Chave: curl -X GET "https://backcore.azun.com.br/api/v1/produtos?pagina=1&limite=50" \ -H "x-api-key: sk_live_9a8b7c6d5e4f3a2b1c" \ -H "Content-Type: application/json" # Exemplo de Cabeçalhos para APIs Livres com Identificação de Loja: curl -X GET "https://backcore.azun.com.br/api/produtos" \ -H "x-tenant-id: 1"
Categoria Especial

APIs Livres & Abertas

Zero Chaves Obrigatórias

Estas rotas estão disponíveis publicamente no backend principal e podem ser chamadas por aplicativos móveis, cardápios online, monitores de status e clientes no restaurante sem necessidade de autenticação prévia de administrador.

GET /api/pdv/health
200 OK • 0ms

Health Check & Status do Servidor Principal

Rota pública ultrarrápida usada pelo AzunPDV.exe e sistemas de monitoramento para testar conectividade e latência.

curl -X GET "https://backcore.azun.com.br/api/pdv/health"
{ "status": "OK", "online": true, "timestamp": "2026-10-26T18:47:46.397Z" }
GET /api/produtos
Header opcional: x-tenant-id

Catálogo Livre de Produtos (E-commerce & Consulta Aberta)

Retorna a lista completa de produtos ativos da loja, incluindo preços, saldo em estoque, imagens, categorias e marcas.

curl -X GET "https://backcore.azun.com.br/api/produtos" -H "x-tenant-id: 1"
[ { "id_produto": 265, "nome": "Macarrão Santa Amália 500G Sêmola Parafuso", "preco": 4.50, "estoque": 142, "ativo": true, "categoria": "Alimentos", "imagem_url": "https://azuntecnologia.com.br/uploads/macarrao.jpg" } ]
GET /api/produtos/busca?keyword=termo
Query: keyword ou termo

Pesquisa Rápida por Código de Barras EAN ou Nome

Busca direta de itens por código de barras, SKU ou correspondência parcial de nome. Suporta leitura via scanner laser ou digitação.

curl -X GET "https://backcore.azun.com.br/api/produtos/busca?keyword=7891234567890" -H "x-tenant-id: 1"
GET /api/autoatendimento/produtos
Público para Mesas

Cardápio Digital de Autoatendimento para Clientes

Carrega itens disponíveis para consumo local em restaurantes, cafeterias e bares, organizados por grupos de produção (Cozinha / Bar / Sobremesas).

curl -X GET "https://backcore.azun.com.br/api/autoatendimento/produtos" -H "x-tenant-id: 1"
GET /api/autoatendimento/m/:token
Token Único do QR Code

Visualização da Comanda e Consumo da Mesa por QR Code

Permite ao cliente escanear o QR Code fixado na mesa física e ver em tempo real todos os itens consumidos, valor parcial e status de preparo.

curl -X GET "https://backcore.azun.com.br/api/autoatendimento/m/MS-TOKEN-MESA-05"
{ "sucesso": true, "mesa": { "id_mesa": 5, "numero": "05", "status": "OCUPADA" }, "comanda": { "id_pedido": 93, "valor_total": 4.50, "itens": [ { "id_produto": 265, "nome": "Macarrão Santa Amália", "quantidade": 1, "preco_unitario": 4.50 } ] } }
POST /api/autoatendimento/m/:token/pedir
Payload JSON

Lançamento Direto de Pedido pelo Cliente na Mesa

O cliente adiciona itens ao carrinho no celular e dispara o pedido diretamente para a impressora ou tela KDS da cozinha.

curl -X POST "https://backcore.azun.com.br/api/autoatendimento/m/MS-TOKEN-MESA-05/pedir" \ -H "Content-Type: application/json" \ -d '{ "itens": [ { "id_produto": 265, "quantidade": 2, "observacao": "Sem cebola" } ] }'
POST /api/autoatendimento/m/:token/pagar-pix
PIX Dinâmico Instantâneo

Auto-pagamento da Mesa via PIX

Gera a chave Copia e Cola e o QR Code PIX para o cliente pagar a comanda sem precisar esperar o garçom com a maquininha.

curl -X POST "https://backcore.azun.com.br/api/autoatendimento/m/MS-TOKEN-MESA-05/pagar-pix"
POST /api/pedidos/driver-confirm
Validação com PIN Seguro

Confirmação de Entrega pelo Motoboy via PIN

Valida o PIN de 4 dígitos informado pelo cliente no ato do recebimento e finaliza a corrida de entrega no ERP.

curl -X POST "https://backcore.azun.com.br/api/pedidos/driver-confirm" \ -H "Content-Type: application/json" \ -d '{ "driver_token": "DRV-TOKEN-789", "delivery_pin": "4821" }'
PUT /api/pedidos/driver-location/:token
Latitude & Longitude

Atualização de Coordenadas GPS do Motoboy

Recebe a latitude e longitude do navegador do motoboy a cada 10 segundos para desenhar o trajeto no mapa do cliente.

curl -X PUT "https://backcore.azun.com.br/api/pedidos/driver-location/DRV-TOKEN-789" \ -H "Content-Type: application/json" \ -d '{ "lat": -3.119028, "lng": -60.021731 }'
GET /api/public-keys
Chaves Públicas de Gateway

Chaves Públicas de Pagamento para Frontend

Retorna com segurança as Public Keys (Mercado Pago, Stripe, etc.) para inicialização do checkout sem expor credenciais secretas.

curl -X GET "https://backcore.azun.com.br/api/public-keys" -H "x-tenant-id: 1"
Integração ERP / CRM

API Pública Externa (v1 & v2)

Requer Header x-api-key

Estas rotas operam diretamente sobre a tabela api_keys do banco de dados, com permissões granulares por chave (ler_produtos, escrever_produtos, ler_pedidos, escrever_pedidos).

GET /api/v1/produtos
Permissão: ler_produtos

Listagem Paginada do Estoque

Busca paginada segura com limitador automático de até 100 itens para proteger o banco de dados. Suporta identificador externo (id_externo).

curl -X GET "https://backcore.azun.com.br/api/v1/produtos?pagina=1&limite=50" \ -H "x-api-key: sk_live_suachaveaqui"
{ "sucesso": true, "sandbox": false, "paginacao": { "total_itens": 236, "pagina_atual": 1, "total_paginas": 5, "itens_na_pagina": 50 }, "produtos": [ { "id_produto": 265, "nome": "Macarrão Santa Amália 500G", "preco": 4.50, "estoque": 142, "ativo": true, "id_externo": "EXT-PROD-998" } ] }
POST /api/v1/produtos
Permissão: escrever_produtos

Cadastro de Novo Produto

Cadastra produtos vindos de outros sistemas. Suporta modo Sandbox (x-sandbox: true) que valida a regra de negócio sem gravar no banco de produção.

curl -X POST "https://backcore.azun.com.br/api/v1/produtos" \ -H "x-api-key: sk_live_suachaveaqui" \ -H "Content-Type: application/json" \ -d '{ "nome": "Coca-Cola Lata 350ml", "preco": 5.00, "estoque": 80, "descricao": "Refrigerante lata", "peso": 0.35, "ativo": true, "id_externo": "CRM-BEB-01" }'
PUT /api/v1/produtos/:id/estoque
Permissão: escrever_produtos

Sincronização Rápida de Saldo de Estoque

Atualiza instantaneamente a quantidade em estoque de um produto no ERP e em todos os caixas PDV conectados.

curl -X PUT "https://backcore.azun.com.br/api/v1/produtos/265/estoque" \ -H "x-api-key: sk_live_suachaveaqui" \ -H "Content-Type: application/json" \ -d '{ "estoque": 150 }'
GET /api/v1/pedidos
Permissão: ler_pedidos

Listagem de Pedidos com Descriptografia de Dados

Retorna os últimos 50 pedidos da loja com itens e endereço de entrega. Telefones e CPFs protegidos são descriptografados em tempo de execução para integrações autorizadas.

curl -X GET "https://backcore.azun.com.br/api/v1/pedidos" \ -H "x-api-key: sk_live_suachaveaqui"
PUT /api/v1/pedidos/:id/rastreio
Permissão: escrever_pedidos

Despacho de Pedido e Código de Rastreio

Registra o código de rastreamento (Correios, Jadlog, Loggi, etc.), altera o status de entrega para 'Enviado' e dispara notificação automática no WhatsApp do cliente.

curl -X PUT "https://backcore.azun.com.br/api/v1/pedidos/93/rastreio" \ -H "x-api-key: sk_live_suachaveaqui" \ -H "Content-Type: application/json" \ -d '{ "codigo_rastreio": "BR987654321AA", "metodo_envio": "Sedex" }'
POST /api/v2/pedidos
Permissão: WRITE_PEDIDOS

Geração de Pedido Oficial com Link / PIX Automático

Rota da API v2 que recebe a lista de produtos, calcula frete e cria o pedido oficial gerando cobrança PIX imediata.

curl -X POST "https://backcore.azun.com.br/api/v2/pedidos" \ -H "x-api-key: sk_live_suachaveaqui" \ -H "Content-Type: application/json" \ -d '{ "id_cliente": 42, "itens": [{ "id_produto": 265, "quantidade": 2 }], "metodo_pagamento": "PIX" }'
Arquitetura Offline C++

PDV Desktop & Sincronização Híbrida

Token de Terminal CX

Estas APIs alimentam o motor nativo em C++ (AzunPDV.exe) e o serviço de sincronização (AzunService.exe), garantindo 0ms de latência no caixa mesmo sem conexão com a internet.

GET /api/pdv/caixas/carga-sync?token=CX-XXXX-XXXX
Token do Caixa

Carga Completa para Operação Offline do Caixa

Baixa em um único payload compactado todos os produtos com código de barras, tributação (NCM, CEST, CFOP, CSOSN), operadores com PIN criptografado, formas de pagamento e série fiscal NFC-e vinculada.

curl -X GET "https://backcore.azun.com.br/api/pdv/caixas/carga-sync?token=CX-0304-EC8F"
GET /api/pdv/caixas/mesas?token=CX-XXXX-XXXX
Sincronização em Tempo Real

Mapa de Mesas e Comandas Abertas

Rota de alta frequência utilizada pela tela de mesas do PDV para monitorar pedidos em aberto, comandas ativas, tempo de permanência e garçom responsável.

curl -X GET "https://backcore.azun.com.br/api/pdv/caixas/mesas?token=CX-0304-EC8F"
POST /api/pdv/caixas/vincular
Pareamento Seguro

Pareamento de Novo Computador Caixa

Registra a máquina física na nuvem usando o código de ativação fornecido no painel admin, gerando um token exclusivo permanente.

curl -X POST "https://backcore.azun.com.br/api/pdv/caixas/vincular" \ -H "Content-Type: application/json" \ -d '{ "codigo_pareamento": "AZUN-7729-BR", "nome_maquina": "CAIXA-01-BALCAO" }'
Automação Tributária

Motor Fiscal SEFAZ (NFC-e & NF-e)

Certificado Digital A1

Geração, assinatura com Certificado Digital A1 (.pfx) em memória, transmissão e autorização direta nos WebServices da SEFAZ de todos os estados brasileiros.

POST /api/fiscal/nfce/emitir
Modelo 65 Varejo

Emissão Instantânea de NFC-e (Modelo 65)

Converte uma venda de balcão em cupom fiscal homologado pela SEFAZ, gerando o protocolo de autorização, chave de acesso de 44 dígitos, XML assinado e link do QR Code estadual.

curl -X POST "https://backcore.azun.com.br/api/fiscal/nfce/emitir" \ -H "Authorization: Bearer seu_token_jwt" \ -H "Content-Type: application/json" \ -d '{ "id_pedido": 93, "consumidor_cpf": "12345678900", "forma_pagamento": "01" }'
POST /api/fiscal/nfe/emitir
Modelo 55 Geral

Emissão de NF-e Comercial (Modelo 55)

Emissão para vendas B2B, devoluções, transferências entre filiais e vendas para outros estados, gerando o DANFE em PDF e XML.

curl -X POST "https://backcore.azun.com.br/api/fiscal/nfe/emitir" \ -H "Authorization: Bearer seu_token_jwt" \ -H "Content-Type: application/json" \ -d '{ "id_pedido": 93, "tipo_operacao": "saida" }'
GET /api/fiscal/testar-sefaz
Status Operacional

Consulta de Disponibilidade do WebService SEFAZ

Testa a comunicação direta com os servidores da SEFAZ estadual e mede a latência em milissegundos.

curl -X GET "https://backcore.azun.com.br/api/fiscal/testar-sefaz" \ -H "Authorization: Bearer seu_token_jwt"
POST /api/fiscal/entrada/importar
Multipart/form-data

Importação Automática de XML de Compras (Fornecedor)

Faz a leitura completa do XML da NF-e emitida pelo fornecedor, cadastra novos produtos automaticamente, atualiza o custo médio e alimenta o saldo em estoque.

curl -X POST "https://backcore.azun.com.br/api/fiscal/entrada/importar" \ -H "Authorization: Bearer seu_token_jwt" \ -F "xml=@nota_fiscal_fornecedor.xml"
Eventos em Tempo Real

Webhooks de Pagamentos & Notificações

Push Assíncrono

Receba avisos instantâneos quando um pagamento for aprovado, quando um pedido for impresso ou quando uma NFC-e for autorizada.

POST /api/v1/webhooks/settings
Header: x-api-key

Cadastrar URL de Webhook

Configura o endereço HTTP da sua aplicação para receber eventos como pedido.pago ou nfce.emitida.

curl -X POST "https://backcore.azun.com.br/api/v1/webhooks/settings" \ -H "x-api-key: sk_live_suachaveaqui" \ -H "Content-Type: application/json" \ -d '{ "url": "https://meucrm.com.br/api/azun-webhook", "evento": "pedido.pago" }'
POST /api/webhooks/:gateway
Mercado Pago / Asaas / Stripe / Cielo / AbacatePay

Endpoints Nativos para Recebimento de Notificações de Pagamento

O backend processa automaticamente os callbacks e atualiza o pedido para 'Pago', liberando a impressão na cozinha ou despacho no estoque:

  • POST /api/webhooks/mercadopago
  • POST /api/webhooks/asaas
  • POST /api/webhooks/stripe
  • POST /api/webhooks/cielo
  • POST /api/webhooks/abacatepay

Códigos de Status HTTP & Resoluções

Todas as respostas seguem os padrões universais da especificação HTTP:

Código Significado Cenário Comum
200 OK Sucesso na Requisição Consulta de produtos, pedidos ou mesas realizada.
201 Created Recurso Criado Novo produto ou pedido cadastrado com sucesso.
400 Bad Request Campos Inválidos Parâmetro obrigatório ausente ou JSON corrompido.
401 Unauthorized Não Autenticado Header x-api-key ausente ou inválido.
403 Forbidden Permissão Negada Chave não possui a permissão específica (ex: escrever_pedidos).
404 Not Found Não Encontrado Produto, mesa ou pedido inexistente nesta loja.
500 Server Error Erro Interno Instabilidade temporária no banco ou SEFAZ offline.