Todas as requisicoes (exceto /api/nfe/status) exigem o header X-Api-Key com sua chave de API.
SUA-API-KEY-AQUI
Verifica se a API esta online. Nao requer autenticacao.
Assina com o certificado A1 e transmite a NF-e para a SEFAZ. O CNPJ no XML e detectado automaticamente para selecionar o certificado correto.
| Campo | Tipo | Descricao |
|---|---|---|
| xml | string * | XML da NF-e sem assinatura. Deve conter o CNPJ do emitente. |
| ambiente | string | "homologacao" (padrao) ou "producao" |
Envia evento de cancelamento para a SEFAZ. Prazo maximo: 24h apos autorizacao em homologacao, ou conforme legislacao estadual em producao.
| Campo | Tipo | Descricao |
|---|---|---|
| chave | string * | Chave de acesso da NF-e (44 digitos) |
| justificativa | string * | Motivo do cancelamento (minimo 15 caracteres) |
| protocoloAutorizacao | string * | Numero do protocolo de autorizacao |
| ambiente | string | "homologacao" ou "producao" (padrao) |
Consulta a situacao atual de uma NF-e diretamente na SEFAZ.
| Parametro | Tipo | Descricao |
|---|---|---|
| chave | path * | Chave de acesso (44 digitos) na URL |
| ambiente | query | "homologacao" ou "producao" (padrao) |
Historico paginado de todas as operacoes realizadas pela sua conta.
| Query | Tipo | Descricao |
|---|---|---|
| pagina | int | Pagina (padrao: 1) |
| por_pagina | int | Registros por pagina, max 100 (padrao: 20) |
| tipo | string | "emissao", "cancelamento" ou "consulta" |
| status | string | "autorizado", "cancelado", "erro" ou "ok" |
Configura a URL e os eventos a receber. O campo eventos e opcional — omita para manter a configuracao atual. Envie url vazio para desativar.
| Campo | Tipo | Descricao |
|---|---|---|
| url | string | URL HTTPS que receberá os POSTs. Vazio para desativar. |
| eventos | string[] | Quais eventos notificar. Opcoes: nfe.autorizada, nfe.erro, nfe.cancelada. Omita para manter atual. |
Quando um evento ocorre, a API faz um POST automatico para sua URL com os dados do evento e retenta ate 3 vezes em caso de falha (backoff exponencial).
PUT /api/nfe/webhookX-Webhook-Signature com seu secret para garantir autenticidadeCada webhook traz o header X-Webhook-Signature: sha256=.... Valide com seu secret para garantir que o POST veio da Noria NF-e.
seu-webhook-secret
| HTTP | Mensagem | Descricao |
|---|---|---|
| 401 | X-Api-Key obrigatorio. | Header ausente na requisicao |
| 401 | API Key invalida. | Chave nao encontrada no sistema |
| 403 | Cliente bloqueado. | Conta suspensa pelo administrador |
| 500 | 539 - Certificado invalido | Certificado A1 expirado ou senha incorreta |
| 500 | Nenhum certificado encontrado | CNPJ emitente sem certificado cadastrado |
| 500 | 225 - Rejeicao SEFAZ | Erro de validacao no XML pela SEFAZ |
| Valor | Descricao |
|---|---|
| homologacao | Testes — notas sem valor fiscal. Use para desenvolvimento. |
| producao | Ambiente real — notas com valor fiscal e legal. Use apos homologar. |