API de integração com o tryERP
Saiba mais sobre a API que integra o seu ERP com tudo
Você tem um sistema de PDV, um app móvel, uma loja virtual, uma plataforma de cotação ou uma integração com um marketplace e precisa conversar com o TryERP. A API TryIdeas é o caminho. Uma REST API moderna, em .NET 9, com OData v4, autenticação JWT, documentação interativa e endpoints cobrindo desde cadastro de produtos até rastreamento de encomendas dos Correios. Tudo pronto para conectar seu sistema ao TryERP em poucas horas.
O que é a API TryIdeas?
A API TryIdeas é a interface programática do TryERP. Por meio dela, qualquer aplicação — própria ou de terceiros — pode consultar e movimentar os dados do ERP: pedidos, produtos, parceiros, notas fiscais, estoque, financeiro, ordens de serviço e muito mais. Atende clientes que construíram soluções customizadas em cima do TryERP.
Stack atualizada para a versão mais recente do .NET. Compressão Gzip + Brotli, bulk operations e queries otimizadas para alta concorrência.
JWT Bearer com HS256. Tokens de 2 horas para integrações e 1 hora para apps móveis. Endpoint /api/Token com clientId + clientSecret.
Filtros, expansão de relacionamentos, seleção de campos, ordenação, paginação — tudo via querystring padrão OData. Reduza payload e número de chamadas.
Scalar UI moderna em /docs, OpenAPI v3 em /openapi/v1.json. Teste endpoints direto pelo navegador, com exemplos.
Comece em 3 Passos
Toda integração segue o mesmo fluxo: autenticar, receber o token, usar o token nas chamadas subsequentes:
POST /api/Token
Content-Type: application/json
{
"clientId": "SEU_CLIENT_ID",
"clientSecret": "SUA_SENHA"
}
# 2. Resposta: token JWT válido por 2 horas
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6...",
"expiresIn": 7200
}
# 3. Use o token nas chamadas seguintes
GET /api/Produto?$top=10
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...
Tokens de 2 horas para integrações servidor-a-servidor. Renove conforme necessário com o mesmo endpoint de login.
Limites de requisições por IP protegem a infraestrutura. Configuráveis conforme o plano contratado.
Toda comunicação é criptografada em trânsito. Em produção, conexões HTTP são automaticamente rejeitadas.
OData: Consulte Como Você Precisa
Em vez de criar 50 endpoints para 50 filtros diferentes, a API TryIdeas usa o padrão OData v4. Você monta a consulta no momento da chamada, escolhendo filtros, campos, ordenação e relacionamentos — tudo via querystring.
# trazendo apenas código, descrição e preço:
GET /api/Produto?$filter=IdGrupo eq 10&$top=50&$orderby=Descricao&$select=Codigo,Descricao,Preco
# Pedidos do mês com itens e cliente expandidos:
GET /api/Pedido?$filter=DataPedido ge 2026-05-01&$expand=PedidoProduto,Parceiro
# Faturas em aberto a vencer:
GET /api/Fatura?$filter=Saldo gt 0&$orderby=DataVencimento
Filtre por qualquer campo com operadores lógicos (eq, ne, gt, ge, lt, le, and, or, contains). Combinações complexas suportadas.
Traga relacionamentos aninhados na mesma chamada. Pedido com produtos, parceiro, faturas e parcelas — profundidade até 6 níveis.
Retorne apenas os campos que precisa. Payloads menores, respostas mais rápidas, menos banda consumida.
Paginação nativa. Para grandes volumes, page-sizes máximos por entidade (Produto 1000, Pedido 600, DFe 500).
$filter=DataUltimaAlteracao ge 2026-05-08T00:00:00Z para puxar só o que mudou desde a última sincronização. Ideal para integrações com BI, marketplaces ou apps offline.
Endpoints Cobrindo Todo o ERP
A API expõe praticamente tudo que faz sentido externalizar do TryERP. Veja os principais grupos de endpoints:
| Área | Endpoints Principais |
|---|---|
| Produtos | /api/Produto, /api/Preco, /api/ProdutoLote, /api/ProdutoFornecedor, /api/Produto/TamanhoPizza/{id} |
| Parceiros | /api/Parceiro, /api/EnderecoParceiro — clientes, fornecedores, transportadoras, vendedores |
| Pedidos | /api/Pedido, /api/PedidoArquivo — com PATCH (RFC 6902) para atualizações parciais |
| Notas Fiscais | /api/NotaFiscal, /api/DFe, /odata/DFeCompleta — NF-e, NFC-e, CT-e, MDF-e com encerramento |
| Estoque | /api/Estoque, /api/EstoqueAjuste — saldos, ajustes, custos calculados |
| Financeiro | /api/Fatura, /api/FaturaParcela, /api/Custo — contas a pagar/receber, parcelas, custos |
| Serviços | /api/OrdemServico, /api/Agendamento — OS, agendamentos, reservas |
| Logística | /api/OrdemCarga, /api/Correios — ordens de carga, postagens, rastreamento |
| Downloads Públicos | /api/DownloadDanfe, /api/DownloadXml — DANFE PDF e XML da NF-e via hash público |
Exemplos de Endpoints
Alguns endpoints comuns que você vai usar no dia a dia:
O Que Mudou nas Últimas Semanas
A API recebeu uma série de melhorias importantes nos últimos meses, com foco em integração logística, qualidade dos documentos fiscais e experiência do desenvolvedor:
Novo controlador /api/Correios com rastreamento em tempo real, postagens por nota fiscal, postagens por emitente (com paginação e filtros por data, status e destinatário), download de etiquetas em PDF, cotações salvas, contratos e serviços disponíveis. Autenticação automática contra a CWS (Correios Web Services) com renovação de bearer token.
Migramos da biblioteca legada ZionDanfe (baseada em PDF Clown, descontinuada) para uma stack moderna: QuestPDF + Zeus DFe.NET. Resultado: DANFEs gerados mais rápido, com fidelidade visual maior e suporte oficial à NT 2020.004 (DANFE Simplificado). Endpoint aceita parâmetro ?formato=0 (padrão A4) ou ?formato=1 (etiqueta com QR Code).
Novos endpoints OData /api/Fatura e /api/FaturaParcela com filtros de negócio já aplicados: exclui automaticamente transferências, saques, depósitos, trocas de numário e entradas em cartão. Foco no que importa: contas a pagar e receber reais. Suporta expand de pagamentos e renegociações.
A documentação ganhou uma cara nova com a Scalar UI — interface moderna, com tema escuro, busca rápida e exemplos de código em várias linguagens. Comentários XML de todos os métodos foram incluídos, com exemplos de queries OData embutidos em cada endpoint. Acesse em /docs.
Suporte Completo a Documentos Eletrônicos
A API não só consulta documentos fiscais — ela ajuda você a operar todo o ciclo. Tudo já com a tecnologia mais atual em proteção, validação e geração de PDF:
Consulta de NF-e por chave, número, período ou pedido. Download do XML e da DANFE em PDF (padrão ou etiqueta).
Mesmo modelo de consulta da NF-e, específico para varejo. Identificado pelo modelo nas queries.
CT-e completo com expand de informações do transporte, emitente, destinatário e detalhes da carga.
Consulta de MDF-e e encerramento direto pela API com UF e município IBGE de encerramento.
hash e um clientId. Com isso, você pode compartilhar a URL /api/DownloadDanfe?clientId=...&hash=... com o cliente final — ele baixa o PDF sem precisar de autenticação, e o link é assinado e validado.
Para Que As Pessoas Usam a API?
| Cenário | Endpoints Envolvidos |
|---|---|
| Integração com e-commerce | Sincronizar produtos, preços e estoque + receber pedidos |
| BI / Data Warehouse | OData com $filter=DataUltimaAlteracao + $expand para carga incremental |
| Portal do cliente | Listar faturas, baixar DANFE/XML, consultar pedidos e rastreio Correios |
| Integração com transportadora | Postar carga + rastrear entrega + listar contratos Correios |
| Plataforma de cotação | Consultar produtos e fornecedores, gerar pedidos de compra com PATCH |
| Marketplace ou hub | Cadastro de produtos via OData + recebimento de pedidos via POST |
Construída Para Produção
A API não é um experimento. Ela roda em produção há anos atendendo dezenas de clientes e milhões de requisições. Sob o capô:
- .NET 9 e Entity Framework Core 9: stack mais recente, com performance benchmarks de classe mundial.
- OData 9.3: implementação oficial da Microsoft, com buffering de subqueries correlacionadas para joins complexos.
- Mapster para mapeamento: mais rápido que AutoMapper, com geração de código em compile-time.
- FluentValidation: regras de validação complexas com mensagens de erro padronizadas.
- Bulk Operations: EFCore.BulkExtensions para inserções e atualizações em lote sem onerar o banco.
- Compressão de resposta: Gzip + Brotli reduzem o payload em até 90% para grandes volumes de dados.
- Application Insights: telemetria, métricas e rastreamento de exceções em produção.
- Prometheus metrics: exposição de métricas operacionais para monitoramento via Grafana.
- Sanitização de erros: mensagens detalhadas em dev, mensagens genéricas em produção — sem vazar stack traces.
- Rate limiting por IP: proteção contra abuso e ataques de força bruta.
- HTTPS forced: RequireHttpsMetadata=true em produção.
- Multi-tenant por connection string: uma API, múltiplos bancos, isolamento total entre clientes.
Pronto para integrar seu sistema ao TryERP?
A API TryIdeas está disponível para todos os clientes do TryERP. Acesse a documentação interativa ou fale com a nossa equipe para receber suas credenciais.