Para Desenvolvedores

API REST Zyntra

A API REST do Zyntra permite que desenvolvedores integrem qualquer sistema externo à nossa plataforma. Com endpoints bem documentados e padrões modernos de desenvolvimento, você pode automatizar processos, sincronizar dados e construir soluções customizadas que se conectam ao ERP dos seus clientes.

Nossa API segue os princípios RESTful, utiliza JSON como formato de dados e autenticação via OAuth 2.0. Todas as chamadas são feitas sobre HTTPS com TLS 1.3, garantindo a segurança dos dados em trânsito.

Recursos Disponíveis via API

• Clientes e Fornecedores: CRUD completo de cadastros, incluindo endereços e contatos
• Produtos e Serviços: Gestão de catálogo, preços, estoque e categorias
• Pedidos de Venda: Criação, consulta, atualização e cancelamento de pedidos
• Notas Fiscais: Emissão, consulta e cancelamento de NF-e, NFS-e e NFC-e
• Financeiro: Contas a pagar, contas a receber, lançamentos e conciliação
• Estoque: Movimentações, saldos, reservas e transferências entre almoxarifados
• Relatórios: Geração de relatórios financeiros, comerciais e operacionais

SDKs e Bibliotecas

Para facilitar a integração, oferecemos SDKs oficiais nas linguagens mais populares:

• Python: pip install zyntra-sdk
• Node.js: npm install @zyntra/sdk
• PHP: composer require zyntra/sdk
• C# / .NET: Disponível via NuGet: Zyntra.SDK
• Java: Disponível via Maven Central

Todos os SDKs são open source e mantidos pela equipe de engenharia da Zyntra. Contribuições da comunidade são bem-vindas via GitHub.

Webhooks

Configure webhooks para receber notificações em tempo real quando eventos acontecem no Zyntra. Isso permite que seus sistemas reajam automaticamente a ações como:

• Novo pedido de venda criado ou atualizado
• Nota fiscal emitida, autorizada ou cancelada
• Pagamento recebido ou estornado
• Produto com estoque abaixo do mínimo
• Novo cliente cadastrado
• Status de cobrança alterado

Os webhooks são enviados via HTTP POST com payload em JSON e incluem assinatura HMAC-SHA256 para validação de autenticidade.

Ambiente de Sandbox

Disponibilizamos um ambiente de sandbox completo para que você desenvolva e teste suas integrações sem risco de afetar dados reais. O sandbox replica todas as funcionalidades da API de produção, incluindo emissão de notas fiscais em ambiente de homologação da SEFAZ.

Para criar sua conta de sandbox, acesse developers.zyntra.com.br e registre-se gratuitamente. Você receberá credenciais de API e acesso à documentação interativa com exemplos em todas as linguagens suportadas.

Rate Limits e Boas Práticas

• Plano Profissional: 1.000 requisições por minuto
• Plano Enterprise: 5.000 requisições por minuto (customizável)
• Utilize paginação em listagens para otimizar o consumo de recursos
• Implemente cache local para dados que mudam com pouca frequência
• Utilize webhooks ao invés de polling para monitorar mudanças
• Sempre valide a assinatura dos webhooks antes de processar o payload

Suporte para Desenvolvedores

Nossa equipe de Developer Relations está disponível para ajudar com dúvidas técnicas, revisão de arquitetura de integração e suporte durante o desenvolvimento. Entre em contato pelo e-mail developers@zyntra.com.br ou acesse nosso fórum de desenvolvedores em community.zyntra.com.br.