Documentação Técnica da API Omie ERP para Integração
Visão Geral
Esta documentação fornece uma análise técnica detalhada e exemplos práticos para a integração com as APIs do Omie ERP. O objetivo principal é servir como um guia completo para o desenvolvimento de um mcp-server em NestJS, facilitando a comunicação e a troca de dados com o sistema Omie.
A estrutura da documentação está organizada por categorias de serviços, refletindo a organização da API Omie. Cada arquivo Markdown contém informações sobre os endpoints, métodos, payloads de requisição e resposta, além de exemplos práticos.
Estrutura da Documentação
- Autenticação: Detalhes sobre o processo de autenticação via API Key e App Secret.
- Guia de Integração com NestJS: Recomendações e um guia passo a passo para construir o
mcp-serverpara interagir com a Omie. - Serviços da API:
* Geral * CRM * Finanças * Compras, Estoque e Produção * Estoque * Vendas e NF-e * Serviços e NFS-e * Painel do Contador
Como Utilizar
- Comece pela Autenticação: Entenda como obter e utilizar suas credenciais de API.
- Consulte o Serviço Desejado: Navegue até o arquivo Markdown correspondente ao serviço que você precisa integrar (por exemplo,
omie-clientes.mdpara a API de Clientes). - Utilize os Exemplos: Os exemplos de payload JSON podem ser usados como base para construir suas requisições.
- Siga o Guia NestJS: Ao desenvolver o
mcp-server, utilize o guia de integração para as melhores práticas e uma implementação mais rápida.