diff --git a/FiscalAPI.postman_collection.json b/FiscalAPI.postman_collection.json index 5eafe0b..41618b6 100644 --- a/FiscalAPI.postman_collection.json +++ b/FiscalAPI.postman_collection.json @@ -2,7 +2,7 @@ "info": { "_postman_id": "a502c70e-5ed7-54dd-9642-eda948b8f723", "name": "FiscalAPI", - "description": "API REST de consultas fiscais e cadastrais do Brasil, com foco no agronegócio: inscrição estadual nas 27 UFs, CNPJ, certidões estaduais e federais, XML de NF-e por chave, imóveis rurais (SIGEF e CNIR) e perfil consolidado do produtor rural. Respostas em JSON.\n\n**Autenticação:** envie sua chave no header `X-API-Key` (formato `fapi_...`). Crie a conta e copie a chave em https://app.fiscalapi.com.br. Nunca exponha a chave no front-end.\n\n**Cobrança:** cada consulta com dado consome créditos do plano (1 na maioria; 3 no CNPJ ao vivo; NF-e conforme o plano). Erros não são cobrados. Erros da origem do dado vêm com HTTP 200 em `source_status` (também não cobrados).\n\n**Grátis:** conta que nunca assinou, com e-mail confirmado e sem recarga, tem 10 consultas grátis por mês em qualquer consulta avulsa, no painel e pela API (cada consulta entregue gasta 1), e mais 10 XML de NF-e com certificado. Ficam fora a NF-e sem certificado, as consultas em todos os estados (IE ou CND) e todas as certidões de uma vez. Quando acabam, o 402 traz `free_queries_used` e `free_queries_limit`.\n\n**Limites:** franquia mensal por conta e limite de requisições por minuto conforme o plano (Lite 5, Starter 20, Pro 60, Enterprise 120). Ao exceder: HTTP 402 `LIMITE_ATINGIDO` (saldo) ou HTTP 429 `RATE_LIMIT_EXCEEDED` (com `Retry-After`).\n\n**Erros:** formato RFC 7807 (`application/problem+json`) com `title` = código do erro e `request_id` para o suporte.\n\nDocumentação completa: https://docs.fiscalapi.com.br\n\n## Como usar\n1. Em **Variables** da coleção, cole sua chave em `apiKey` (fica só no seu Postman).\n2. Abra uma pasta, escolha a requisição e clique em **Send**.\n3. Veja respostas de exemplo em **Examples** de cada requisição.\n\nOs exemplos usam documentos fictícios (CNPJ 12.345.678/0001-95). Troque pelo documento que você quer consultar.", + "description": "API REST de consultas fiscais e cadastrais do Brasil, com foco no agronegócio: inscrição estadual nas 27 UFs, CNPJ, certidões estaduais e federais, XML de NF-e por chave, imóveis rurais (SIGEF e CNIR) e perfil consolidado do produtor rural. Respostas em JSON.\n\n**Autenticação:** envie sua chave no header `X-API-Key` (formato `fapi_...`). Crie a conta e copie a chave em https://app.fiscalapi.com.br. Nunca exponha a chave no front-end.\n\n**Cobrança:** cada consulta com dado consome créditos do plano (1 na maioria; 3 no CNPJ ao vivo; NF-e conforme o plano). Erros não são cobrados. Erros da origem do dado vêm com HTTP 200 em `source_status` (também não cobrados).\n\n**Plano ou recarga:** pela API, toda consulta pede plano (a partir de R$ 19,99/mês) ou saldo de recarga. As 10 consultas grátis do mês são só no painel (https://app.fiscalapi.com.br): teste lá antes de assinar. Sem plano nem saldo, o 402 é `LIMITE_ATINGIDO`.\n\n**Limites:** franquia mensal por conta e limite de requisições por minuto conforme o plano (Lite 5, Starter 20, Pro 60, Enterprise 120). Ao exceder: HTTP 402 `LIMITE_ATINGIDO` (saldo) ou HTTP 429 `RATE_LIMIT_EXCEEDED` (com `Retry-After`).\n\n**Erros:** formato RFC 7807 (`application/problem+json`) com `title` = código do erro e `request_id` para o suporte.\n\nDocumentação completa: https://docs.fiscalapi.com.br\n\n## Como usar\n1. Em **Variables** da coleção, cole sua chave em `apiKey` (fica só no seu Postman).\n2. Abra uma pasta, escolha a requisição e clique em **Send**.\n3. Veja respostas de exemplo em **Examples** de cada requisição.\n\nOs exemplos usam documentos fictícios (CNPJ 12.345.678/0001-95). Troque pelo documento que você quer consultar.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { @@ -1501,7 +1501,7 @@ "consultar-nfe-xml-sem-certificado" ] }, - "description": "Retorna uma **cópia para leitura** do XML de **uma** NF-e (modelo 55) a partir da chave de acesso de 44 dígitos, **sem certificado digital**. Traz itens (NCM, CFOP, quantidade, valor), impostos, emitente, destinatário, transporte e pagamento. Vem sem a assinatura digital (`assinado: false`, `tipo_xml: \"leitura\"`): serve para ler, não para escriturar, e não mostra se a nota foi cancelada. Para o XML assinado (nfeProc), use **Baixar XML da NF-e por chave de acesso**, com o certificado A1.\n\n**Plano:** precisa de plano (a partir do Lite); não entra nas consultas grátis.\n\n**Cobrança:** cobra o XML entregue e também a chave válida cuja nota não foi encontrada (`nao_encontrado`). Chave inválida, `erro` e a mesma chave repetida logo depois de um `nao_encontrado` não são cobrados.\n\nPágina: https://fiscalapi.com.br/xml-nfe-sem-certificado/ · Documentação: https://docs.fiscalapi.com.br", + "description": "Retorna uma **cópia para leitura** do XML de **uma** NF-e (modelo 55) a partir da chave de acesso de 44 dígitos, **sem certificado digital**. Traz itens (NCM, CFOP, quantidade, valor), impostos, emitente, destinatário, transporte e pagamento. Vem sem a assinatura digital (`assinado: false`, `tipo_xml: \"leitura\"`): serve para ler, não para escriturar, e não mostra se a nota foi cancelada. Para o XML assinado (nfeProc), use **Baixar XML da NF-e por chave de acesso**, com o certificado A1.\n\n**Plano:** precisa de plano (a partir do Lite).\n\n**Cobrança:** cobra o XML entregue e também a chave válida cuja nota não foi encontrada (`nao_encontrado`). Chave inválida, `erro` e a mesma chave repetida logo depois de um `nao_encontrado` não são cobrados.\n\nPágina: https://fiscalapi.com.br/xml-nfe-sem-certificado/ · Documentação: https://docs.fiscalapi.com.br", "body": { "mode": "raw", "raw": "{\n \"chave\": \"{{chaveNfe}}\"\n}", diff --git a/README.md b/README.md index c9f79c9..286666b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ A coleção também está publicada no Postman: [FiscalAPI na Postman API Networ 3. Na coleção, abra **Variables** e cole a chave em `apiKey`, na coluna *Current value*. 4. Envie qualquer requisição. A chave vai no cabeçalho `X-API-Key`. -Conta que nunca assinou plano, com e-mail confirmado e sem recarga, tem 10 consultas grátis por mês, no painel e pela API, em qualquer consulta avulsa (IE em um estado, CNPJ inclusive ao vivo, Simples Nacional, NFS-e, certidões, CNIR, SIGEF e as demais). Cada consulta entregue gasta 1 das 10; erro não gasta. Ficam fora a NF-e sem certificado, a IE e a CND em todos os estados (`/api/consultar-ie-todos`, `/api/consultar-cnd-todos`) e todas as certidões de uma vez (`/api/certidoes-todas`). À parte, 10 XML de NF-e com certificado por mês. Fora disso, ou depois das 10, é preciso plano ou saldo: a API responde `402` (`LIMITE_ATINGIDO`; quando acabam as grátis, com `free_queries_used` e `free_queries_limit`). Sem chave, `403` (`API_KEY_ERROR`). Planos, limites e consumo de créditos estão na [documentação](https://docs.fiscalapi.com.br). +Pela API, toda consulta pede plano ou saldo de recarga, a partir de R$ 19,99/mês. As 10 consultas grátis do mês são só no painel: teste lá antes de assinar. Sem plano nem saldo, a API responde `402` (`LIMITE_ATINGIDO`). Sem chave, `403` (`API_KEY_ERROR`). Planos, limites e consumo de créditos estão na [documentação](https://docs.fiscalapi.com.br). ## SDKs diff --git a/openapi-publico.json b/openapi-publico.json index 22e6194..cb661b3 100644 --- a/openapi-publico.json +++ b/openapi-publico.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "FiscalAPI", - "description": "API REST da FiscalAPI para consultar inscrição estadual (IE) nos 27 estados, CNPJ, certidões negativas estaduais e federais, XML de NF-e pela chave de acesso, NFS-e do padrão nacional pela chave de acesso, imóveis rurais (CNIR e SIGEF), Simples Nacional, status da SEFAZ e o catálogo de rejeições da NF-e.\n\nAutenticação: envie a sua chave no cabeçalho `X-API-Key`. A chave é criada no painel (app.fiscalapi.com.br); sem ela, ou com chave inválida, a resposta é 403.\n\nCobrança: as consultas usam o saldo do plano. Conta que nunca assinou, com e-mail confirmado, tem 10 consultas grátis por mês em qualquer consulta avulsa, somadas com as do painel, e mais 10 XML de NF-e com certificado. Não entram no grátis a NF-e sem certificado e as consultas em todos os estados ou de todas as certidões de uma vez. O resto pede plano ou saldo, e a chamada sem saldo devolve 402. Limite por minuto conforme o plano; acima dele, 429 com o cabeçalho Retry-After.\n\nDocumentação completa: https://docs.fiscalapi.com.br", + "description": "API REST da FiscalAPI para consultar inscrição estadual (IE) nos 27 estados, CNPJ, certidões negativas estaduais e federais, XML de NF-e pela chave de acesso, NFS-e do padrão nacional pela chave de acesso, imóveis rurais (CNIR e SIGEF), Simples Nacional, status da SEFAZ e o catálogo de rejeições da NF-e.\n\nAutenticação: envie a sua chave no cabeçalho `X-API-Key`. A chave é criada no painel (app.fiscalapi.com.br); sem ela, ou com chave inválida, a resposta é 403.\n\nCobrança: as consultas usam o saldo do plano. Sem plano ou saldo, a chamada devolve 402. Para testar antes de assinar, use as 10 consultas grátis do mês no painel. Limite por minuto conforme o plano; acima dele, 429 com o cabeçalho Retry-After.\n\nDocumentação completa: https://docs.fiscalapi.com.br", "version": "1.0.0" }, "servers": [ @@ -91,7 +91,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -219,7 +219,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -470,7 +470,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -600,7 +600,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -838,7 +838,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -957,7 +957,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -1088,7 +1088,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -1207,7 +1207,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/json": { "schema": { @@ -1453,7 +1453,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/problem+json": { "schema": { @@ -1561,7 +1561,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/problem+json": { "schema": { @@ -1700,7 +1700,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/problem+json": { "schema": { @@ -1820,7 +1820,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/problem+json": { "schema": { @@ -1915,7 +1915,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/problem+json": { "schema": { @@ -2061,7 +2061,7 @@ "NFS-e" ], "summary": "Consultar NFS-e por chave de acesso", - "description": "Consulta uma NFS-e do padrão nacional a partir da chave de acesso (50 dígitos), sem certificado digital. Retorna emitente, tomador, serviço, tributação municipal e federal e a situação de geração (`situacao`: 100 gerada, 101 de substituição, 102 por decisão judicial, 103 avulsa); `situacao` não indica cancelamento. Com `danfse=true`, inclui o PDF do DANFSe em base64 (`danfse_pdf_base64`). Uma consulta nova leva de 30 a 60 segundos; a mesma chave consultada de novo em até 24 h volta do cache na hora (`cached: true`) e também é cobrada. Cobra só a NFS-e entregue (mesmo preço do XML de NF-e sem certificado). Chave inválida, nota não encontrada e falha não são cobradas. Conta sem plano pode usar as consultas grátis do mês.", + "description": "Consulta uma NFS-e do padrão nacional a partir da chave de acesso (50 dígitos), sem certificado digital. Retorna emitente, tomador, serviço, tributação municipal e federal e a situação de geração (`situacao`: 100 gerada, 101 de substituição, 102 por decisão judicial, 103 avulsa); `situacao` não indica cancelamento. Com `danfse=true`, inclui o PDF do DANFSe em base64 (`danfse_pdf_base64`). Uma consulta nova leva de 30 a 60 segundos; a mesma chave consultada de novo em até 24 h volta do cache na hora (`cached: true`) e também é cobrada. Cobra só a NFS-e entregue (mesmo preço do XML de NF-e sem certificado). Chave inválida, nota não encontrada e falha não são cobradas.", "operationId": "consultar_nfse_endpoint_api_consultar_nfse_get", "parameters": [ { @@ -2117,7 +2117,7 @@ } }, "402": { - "description": "Saldo insuficiente para esta consulta (ou cota grátis do mês usada). Assine um plano ou recarregue.", + "description": "Saldo insuficiente para esta consulta. Assine um plano ou recarregue.", "content": { "application/problem+json": { "schema": { @@ -4474,18 +4474,6 @@ ], "description": "Quantas consultas deste tipo o saldo ainda paga." }, - "free_queries_used": { - "type": "integer", - "description": "Consultas grátis do mês já usadas (só quando a cota acabou)." - }, - "free_queries_limit": { - "type": "integer", - "description": "Consultas grátis por mês." - }, - "free_queries_renew_on": { - "type": "string", - "description": "Dia em que a cota grátis renova (DD/MM/AAAA)." - }, "retry_after": { "type": "integer", "description": "Segundos até poder tentar de novo (429)."