Guia de Primeiros Passos
Se você está integrando pela primeira vez, siga esta sequência em ordem. Não pule etapas.
Sumário
- Fluxo geral
- Etapa 1 — Obter credenciais
- Etapa 2 — Localizar seu company_id
- Etapa 3 — Ativar o inbound
- Etapa 4 — Configurar seu endpoint de webhook
- Etapa 5 — Verificar que documentos chegam
- Etapa 6 — Migrar para produção
Fluxo geral
Etapa 1 — Obter credenciais
No painel nfe.io, crie uma API Key em Configurações → Chaves de API. Guarde-a com segurança — ela só é exibida uma vez.
Etapa 2 — Localizar seu company_id
Em Empresas, clique na empresa que deseja integrar e copie o company_id exibido na URL ou nos detalhes da empresa.
Etapa 3 — Ativar o inbound
Faça uma requisição para ativar o monitoramento do CNPJ:
curl -X POST \
"https://api.nfe.io/v2/companies/SEU_COMPANY_ID/inbound/productinvoices" \
-H "Authorization: ApiKey SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"StartFromNsu": 0,
"StartFromDate": "2024-01-01T00:00:00Z",
"EnvironmentSEFAZ": "Production",
"WebhookVersion": 2
}'
Resposta esperada: { "status": "Active", ... }
Etapa 4 — Configurar seu endpoint de webhook
No painel nfe.io, vá em Webhooks e cadastre a URL do seu servidor que vai receber as notificações.
Mínimo necessário no seu endpoint:
# Python (Flask)
@app.route('/webhook', methods=['POST'])
def webhook():
data = request.json
access_key = data['accessKey']
# Processar...
return '', 200 # OBRIGATÓRIO retornar 200
Etapa 5 — Verificar que documentos chegam
Após ativar, aguarde entre 15 minutos e 4 horas. Consulte documentos recebidos:
curl "https://api.nfe.io/v2/companies/SEU_COMPANY_ID/inbound/productinvoices/CHAVE_44_DIGITOS" \
-H "Authorization: ApiKey SUA_API_KEY"
Etapa 6 — Migrar para produção
Quando seus testes estiverem OK com "EnvironmentSEFAZ": "Test", recrie a configuração com "Production":
# 1. Desativar o inbound de homologação
curl -X DELETE \
"https://api.nfe.io/v2/companies/SEU_COMPANY_ID/inbound/productinvoices" \
-H "Authorization: ApiKey SUA_API_KEY"
# 2. Ativar com ambiente de produção
curl -X POST \
"https://api.nfe.io/v2/companies/SEU_COMPANY_ID/inbound/productinvoices" \
-H "Authorization: ApiKey SUA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"StartFromNsu": 0,
"StartFromDate": "2024-01-01T00:00:00Z",
"EnvironmentSEFAZ": "Production",
"WebhookVersion": 2
}'
Importante: Documentos de ambiente
Test(homologação SEFAZ) eProductionsão separados. Nunca misture os dois na mesma configuração.