Pular para o conteúdo principal

Roteamento multi-host

A plataforma NFE.io expõe várias APIs em hosts diferentes. O SDK roteia cada recurso automaticamente para o host certo — nenhum recurso hard-codeia uma URL. Cada recurso declara uma família de API e obtém seu host e sua chave a partir do Nfe\Config.

Famílias, hosts e recursos

FamíliaHostRecursos
mainapi.nfe.io (/v1)serviceInvoices, companies, legalPeople, naturalPeople, webhooks
cteapi.nfse.io (/v2)productInvoices, consumerInvoices, transportationInvoices, inboundProductInvoices, taxCalculation, taxCodes, stateTaxes
addressesaddress.api.nfe.io/v2consulta de endereços (CEP)
legal-entitylegalentity.api.nfe.ioconsulta de pessoa jurídica (CNPJ)
natural-personnaturalperson.api.nfe.ioconsulta de pessoa física (CPF)
nfe-querynfe.api.nfe.ioproductInvoiceQuery, consumerInvoiceQuery
O segmento de versão

Para a família main, o /v1 é fornecido pela versão de API de cada recurso, não pelo host. O host de addresses já embute o /v2. Uma família desconhecida cai no host main como padrão seguro.

Modelo de duas chaves

O SDK usa duas chaves de API. As famílias de dados preferem dataApiKey (com fallback para apiKey); todas as outras famílias usam apiKey.

As famílias de dados são:

  • addresses (CEP)
  • legal-entity (CNPJ)
  • natural-person (CPF)
  • nfe-query (consultas de NF-e/NFC-e por chave de acesso)
$nfe = new Nfe\Client(
apiKey: $_ENV['NFE_API_KEY'],
dataApiKey: $_ENV['NFE_DATA_API_KEY'] ?? null,
);
cte NÃO é família de dados

A família cte (api.nfse.io — emissão de NF-e/NFC-e, CT-e, entrada, cálculo de impostos, tax codes e inscrições estaduais) usa a apiKey principal, e não a dataApiKey. Neste SDK a emissão é uma capacidade central, não uma consulta de dados. Código Node portado que dependia de dataApiKey para api.nfse.io passa a enviar silenciosamente a chave principal.

403 nas famílias de dados

Um AuthorizationException (403) em addresses/legalEntityLookup/ naturalPersonLookup/productInvoiceQuery com uma chave principal válida normalmente significa que o plano dessa chave não inclui o produto de dados. Informe uma dataApiKey provisionada para o plano de dados.

Override por requisição: RequestOptions->baseUrl

Para apontar uma chamada para outro host (mock, proxy, ambiente de testes próprio), use o Nfe\Http\RequestOptions que todo método aceita como último argumento:

use Nfe\Http\RequestOptions;

$invoice = $nfe->serviceInvoices->retrieve(
$companyId,
$invoiceId,
new RequestOptions(baseUrl: 'https://mock.local/nfe'),
);

Para redirecionar todo o tráfego (testes de integração, gravação de cassetes), injete um Nfe\Http\Transport customizado no Nfe\Config — o SDK não tem um mapa global de overrides por família.

Próximos passos

NFE.io

A NFE.io é uma empresa de tecnologia que fornece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas. Com suas ferramentas, as empresas podem economizar tempo e reduzir erros, aumentando a eficiência e precisão do processo de emissão de notas fiscais.

Um dos principais cases de sucesso da NFE.io é a implementação da solução na empresa de transporte Rodonaves. Com a automatização da emissão e gestão de notas fiscais eletrônicas, a Rodonaves conseguiu reduzir em até 80% o tempo gasto nesse processo, o que se traduziu em uma significativa melhoria na eficiência operacional. Além disso, a empresa também conseguiu eliminar erros e atrasos na emissão de notas fiscais, o que melhorou a relação com seus clientes e aumentou a confiança dos órgãos fiscais.

Outro exemplo é a implementação da NFE.io na empresa de comércio eletrônico, a Loja Integrada. Com a automatização da emissão de notas fiscais, a Loja Integrada conseguiu aumentar a velocidade de emissão de notas em até 10 vezes, o que permitiu que a empresa atendesse a uma maior quantidade de clientes e, consequentemente, aumentar as suas vendas.

Além desses exemplos, a NFE.io também tem outros cases de sucesso com empresas de setores como indústria, construção, varejo e serviços, mostrando a versatilidade e eficácia da sua solução.

Em resumo, a NFE.io é uma empresa de tecnologia que oferece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas, ajudando as empresas a economizar tempo e reduzir erros, melhorando a eficiência e precisão do processo. Com cases de sucesso em diferentes setores, a NFE.io tem se destacado como uma empresa líder em automação fiscal.