# API RMF

> API REST da RMF Inteligência Estratégica: consultas de ICMS e da Reforma Tributária, envio de SPED e XML, relatórios fiscais e webhooks. Campos em português, snake_case. Comece pelo sandbox (https://sandbox.api.rmfestrategia.com/v1) com uma chave rmf_test_.

## Começar
- [Primeira chamada em 5 minutos](https://docs.rmfestrategia.com/comecar/primeira-chamada.md): Consulte a alíquota interna de ICMS de um NCM em SP pelo sandbox, leia a resposta e decida pela confiança.
- [Autenticação e escopos](https://docs.rmfestrategia.com/comecar/autenticacao.md): Authorization Bearer, chaves rmf_live_ e rmf_test_, escopos por chave e os erros 401 e 403.
- [Como conseguir a chave](https://docs.rmfestrategia.com/comecar/chave.md): A chave de API é emitida pela equipe da RMF, pelo seu contato comercial. Não há cadastro nem emissão de chave neste portal.
- [Erros](https://docs.rmfestrategia.com/comecar/erros.md): Formato dos erros (application/problem+json), o campo codigo e a lista de todos os códigos.
- [Idempotência](https://docs.rmfestrategia.com/comecar/idempotencia.md): Idempotency-Key em todo POST que cria recurso ou trabalho, guardada por 24 horas, por conta e por operação.
- [Limites e cotas](https://docs.rmfestrategia.com/comecar/limites.md): 429 com Retry-After, cabeçalhos RateLimit-Policy e RateLimit, cota do dia em GET /v1/conta/uso e tamanhos máximos.
- [Paginação](https://docs.rmfestrategia.com/comecar/paginacao.md): Listas paginadas por cursor, com limite e proximo_cursor.
- [Sandbox](https://docs.rmfestrategia.com/comecar/sandbox.md): O sandbox é um serviço separado da produção, com banco próprio, limites menores e resultados fixos para os arquivos de exemplo.
- [Versões e descontinuação](https://docs.rmfestrategia.com/comecar/versoes.md): A versão vai no caminho (/v1). Mudança aditiva não muda a versão; descontinuação vem com Deprecation e Sunset, com 6 meses de aviso.

## Guias
- [Comparar regimes](https://docs.rmfestrategia.com/guias/comparar-regimes.md): Comparar a carga mensal no Simples, no Lucro Presumido e no Lucro Real com POST /v1/reforma/simulacoes/regimes.
- [Conferir a alíquota de ICMS antes de emitir](https://docs.rmfestrategia.com/guias/conferir-aliquota-icms.md): Consultar a alíquota de ICMS de cada NCM na UF de destino antes de emitir a nota, em lote, e decidir pela confiança.
- [Diagnóstico federal](https://docs.rmfestrategia.com/guias/diagnostico-federal.md): Pedir o relatório diagnostico_federal e ler o resumo por ocorrência.
- [Enviar o SPED e receber o relatório de ICMS-ST](https://docs.rmfestrategia.com/guias/enviar-sped.md): Cadastrar a empresa, enviar o SPED, esperar a leitura pelo job, criar o relatório icms_st e guardar o resumo.
- [Simular a Reforma no preço](https://docs.rmfestrategia.com/guias/simular-reforma.md): Simular a transição de 2026 a 2033 (CBS, IBS e IS) a partir do perfil e da receita, com POST /v1/reforma/simulacoes/transicao.
- [Receber webhook e validar a assinatura](https://docs.rmfestrategia.com/guias/webhooks.md): Criar o webhook, receber os eventos e validar a assinatura Standard Webhooks (HMAC-SHA256) em 7 linguagens.

## Use com IA
- [Use com IA](https://docs.rmfestrategia.com/use-com-ia.md): Prompt de integração por caso de uso e linguagem, llms.txt, páginas em Markdown, modelo de AGENTS.md e MCP de documentação.
- [Modelo de AGENTS.md](https://docs.rmfestrategia.com/AGENTS.md): regras de integração para colar no repositório
- [Todas as páginas num arquivo](https://docs.rmfestrategia.com/llms-full.txt): llms-full.txt, para colar inteiro no contexto

## Conta
- [Chaves e escopos](https://docs.rmfestrategia.com/conta/chaves-e-escopos.md): Formato da chave, escopos por chave, vencimento, lista de IPs e troca sem parar.
- [Planos e acesso](https://docs.rmfestrategia.com/conta/planos.md): O plano da conta define o que as chaves podem chamar. Como pedir acesso e uma chave.

## Códigos de erro
- Uma página por código, em https://docs.rmfestrategia.com/erros/<codigo>.md (o campo `type` do problem+json aponta para a versão HTML). A lista completa está em [Erros](https://docs.rmfestrategia.com/comecar/erros.md).

## Referência
- [Contrato OpenAPI 3.1 (JSON)](https://docs.rmfestrategia.com/openapi/rmf-api-v1.json)
- [Contrato OpenAPI 3.1 (YAML)](https://docs.rmfestrategia.com/openapi/rmf-api-v1.yaml)
- [Referência interativa](https://docs.rmfestrategia.com/referencia)

## Opcional
- [Changelog](https://docs.rmfestrategia.com/changelog.md): O que mudou na API e no portal.
- [Privacidade e tratamento de dados](https://docs.rmfestrategia.com/privacidade.md): Rascunho da política de privacidade e do tratamento de dados da API. Texto sujeito à revisão jurídica.
- [Status](https://docs.rmfestrategia.com/status.md): Como saber se a API está no ar e onde ficam os incidentes.
- [Suporte](https://docs.rmfestrategia.com/suporte.md): Como pedir ajuda com a API, a chave ou o plano.
- [Termos de uso](https://docs.rmfestrategia.com/termos.md): Rascunho dos termos de uso da API. Texto sujeito à revisão jurídica.