White-Label, CNAME & Gestão via API

Domínio personalizado para DANFE/XML, customização de marca e gestão de sub-clientes.

A Org API & White-Label do NFER permite que plataformas, ERPs e integradores façam a gestão programática completa de sub-clientes (empresas, certificados digitais, API keys) e disponibilizem a visualização de DANFE em PDF e download do XML sob o seu próprio domínio e marca, sem qualquer menção visual ao NFER para o consumidor final.

Domínio Personalizado (CNAME)

Apresente links como https://danfe.seuerp.com.br/352608... com certificado SSL automático.

Personalização de Marca

Configure seu nome de marca (brand_name), logomarca e cores primárias para as páginas públicas e cabeçalhos.

1. Como Configurar o Domínio Personalizado (CNAME)

Para que seus clientes acessem a DANFE e o XML no seu domínio, você só precisa criar uma entrada DNS do tipo CNAME no seu provedor de DNS (Cloudflare, Registro.br, Route53, GoDaddy, etc.).

TipoNome / HostDestino / Valor (Target)TTL / Proxy
CNAMEdanfe (ou nfe)cname.nfer.meAuto / DNS Only (ou Cloudflare Proxied)
CNAMExml (opcional)cname.nfer.meAuto / DNS Only

Dica Cloudflare (SSL Gratuito e CDN)

Se o seu domínio estiver no Cloudflare, você pode deixar a nuvem Laranja (Proxied) ativa com SSL definido como Full / Strict. O tráfego de PDF e XML será acelerado pela CDN global sem custos de transferência.

2. Links Públicos Diretos para Consumidores

Quando você emite uma NF-e ou NFC-e, a API retorna automaticamente as URLs prontas para envio por WhatsApp ou e-mail. Não é necessário nenhum token na URL: a própria Chave de Acesso de 44 dígitos autoriza a exibição.

1
2
3
4
5
6
7
# Domínio padrão NFER:
https://danfe.nfer.me/35260812345678000195550010000001231000001234
https://xml.nfer.me/35260812345678000195550010000001231000001234
# Com seu CNAME White-Label configurado:
https://danfe.seuerp.com.br/35260812345678000195550010000001231000001234
https://danfe.seuerp.com.br/35260812345678000195550010000001231000001234?download=1

Parâmetros Opcionais de Query:

  • ?download=1 — Força o download do arquivo (Content-Disposition: attachment) em vez de abrir inline no navegador.
  • ?regenerate=1 — Força a regeração do layout do PDF no storage.

3. Autenticação da Org API

Para realizar operações de organização (criar empresas, listar filiais e configurar white-label), utilize seu Organization Token com prefixo nfer_org_ no header x-api-key.

1
2
curl -X GET https://api.nfer.me/v1/org/settings \
-H "x-api-key: nfer_org_seu_token_aqui"

4. Endpoints da Org API

GET/v1/org/settings

Consulta as configurações de marca, domínio CNAME e uso da organização.

PATCH/v1/org/settings

Atualiza o domínio CNAME, URL base do storage e customizações de marca.

POST/v1/org/settings/verify-cname

Testa a resolução DNS do seu domínio CNAME.

GET/v1/org/projects

Lista todas as empresas/filiais cadastradas na organização.

POST/v1/org/projects

Cadastra uma nova empresa emissora na organização (onboarding automático).

POST/v1/org/projects/:id/certificate

Faz upload do Certificado Digital A1 (.pfx) para uma empresa.

POST/v1/org/projects/:id/logo

Envia a logomarca da DANFE da empresa.

PATCH/v1/org/projects/:id/numeracao

Ajusta a sequência numérica inicial das notas (NF-e mod. 55 e NFC-e mod. 65).

5. Exemplo: Configurando o White-Label via API

1
2
3
4
5
6
7
8
curl -X PATCH https://api.nfer.me/v1/org/settings \
-H "x-api-key: nfer_org_XXXXXXXXXXXXXXXX" \
-H "Content-Type: application/json" \
-d '{
"customDomain": "danfe.meuerp.com.br",
"brandName": "MeuERP Fiscal",
"brandPrimaryColor": "#0066FF"
}'
1
2
3
4
5
6
7
8
{
"customDomain": "danfe.meuerp.com.br",
"customDomainStatus": "pending_verification",
"brandName": "MeuERP Fiscal",
"brandPrimaryColor": "#0066FF",
"cnameTarget": "cname.nfer.me",
"message": "Configure o CNAME do domínio apontando para cname.nfer.me."
}