Para IAs e agentes
A Emitfy publica contexto machine-readable para Cursor, ChatGPT, Claude e outros agentes — sem precisar parsear o HTML da documentação.
Início rápido (3 caminhos)
- Página .md — cada doc humana tem um espelho Markdown (ex.:
/docs/webhooks.md). Use o botão Copiar página / Ver como Markdown no topo. - llms.txt — https://api.emitfy.com/llms.txt — índice curto (mapa de links). Bom para descoberta com pouco token.
- llms-full.txt — https://api.emitfy.com/llms-full.txt — contrato self-contained: rotas, regras, campos principais e exemplos. Prefira este arquivo ao pedir integração ao agente.
Markdown por página
Nos botões do cabeçalho das docs você encontra:
- Copiar página — coloca o Markdown (com frontmatter) na área de transferência.
- Abrir no ChatGPT / Abrir no Claude — abre o chat pedindo para ler a URL
.md. - Ver como Markdown — abre o espelho
.mdem texto puro.
O frontmatter inclui title, description, source_url e last_updated. Agentes devem citar o source_url ao responder.
Arquivos oficiais (host da API)
- https://api.emitfy.com/llms.txt
- https://api.emitfy.com/llms-full.txt
- https://api.emitfy.com/openapi.yaml — trecho OpenAPI 3 da API REST (fonte enxuta; amplie conforme o contrato evolui).
O llms-full não lista cada campo fiscal avançado (alíquotas, CFOP, CSC, etc.); para isso o agente deve seguir o link da página humana correspondente.
Modelo Conta × Assinatura
| Camada | O que é | Na API |
|---|---|---|
| Conta | Quem paga (plano, faturas, métodos de pagamento) | Billing no painel |
| Assinatura | Hub operacional 1:1 com a conta | Keys e webhooks em /v1/webhooks |
| Empresa | CNPJ (certificado, emissão, catálogo) | /v1/companies/:companyId/... |
Chaves de API são da assinatura/conta. Webhooks também — um endpoint cobre todas as empresas; o payload traz companyId e taxId. Emissão e catálogo continuam com companyId no path.
Dois fluxos de emissão
| Cenário | Endpoint |
|---|---|
| Emissão pontual | POST /v1/companies/{companyId}/nfse ou POST /v1/companies/{companyId}/nfe |
| SaaS recorrente / cadastro já corrigido | Catálogo: POST /v1/companies/{companyId}/customers, .../products, .../sales com customer: "<uuid>" |
Headers obrigatórios
Shell
X-Api-Key: <api-key>
X-Api-Secret: <api-secret>
Content-Type: application/jsonBoas práticas para agentes
- Preferir
llms-full.txtpara integrar; usellms.txtsó para descoberta. - Ao usar uma página
.md, cite osource_urldo frontmatter. - Não invente CRUD de webhook por empresa — use
/v1/webhooks. - OpenAPI é um trecho mínimo; confirme regras finas no
llms-fullou na doc humana. - SDKs oficiais: /docs/sdks (PHP, Node, .NET, Python, Java). Alternativa: CodeTabs e OpenAPI.
Documentação humana: Introdução, Autenticação, Webhooks, SDKs, Vendas.