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)

  1. 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.
  2. llms.txthttps://api.emitfy.com/llms.txt — índice curto (mapa de links). Bom para descoberta com pouco token.
  3. llms-full.txthttps://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 .md em 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)

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

CamadaO que éNa API
ContaQuem paga (plano, faturas, métodos de pagamento)Billing no painel
AssinaturaHub operacional 1:1 com a contaKeys e webhooks em /v1/webhooks
EmpresaCNPJ (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árioEndpoint
Emissão pontualPOST /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/json

Boas práticas para agentes

  • Preferir llms-full.txt para integrar; use llms.txt só para descoberta.
  • Ao usar uma página .md, cite o source_url do frontmatter.
  • Não invente CRUD de webhook por empresa — use /v1/webhooks.
  • OpenAPI é um trecho mínimo; confirme regras finas no llms-full ou 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.