Arquivos
Download de arquivos
Baixa o XML original ou o PDF do documento a partir dos links devolvidos pelas consultas e callbacks.
GET
/openapi/files/{kind}/{ref}Não requer cabeçalhos de assinatura.
Os links de download nas respostas de consulta e nas cargas de callback têm o formato https://api.v2.tffiscal.com/openapi/files/{kind}/{ref}?token=…. Não há cabeçalhos de assinatura: o token viaja no link e um GET simples basta. O token é vinculado ao caminho, ao integrador e à aplicação; alterar o caminho ou reutilizá-lo em outro arquivo o invalida. Use o link exatamente como devolvido.
Parâmetros de caminho
kind* | string | Tipo do arquivo |
ref* | string | Referência do arquivo |
* Campo obrigatório
Parâmetros de consulta
token* | string | Token do link |
* Campo obrigatório
302
Redireciona para uma URL de armazenamento de objetos válida por 60 segundos. O cliente deve seguir redirecionamentos (
curl -L). A resposta traz Cache-Control: no-store; não faça cache dos links.Sem corpo de resposta
- Validade: 7 dias por padrão; a plataforma pode configurar de 1 a 365 dias por integrador, e a configuração só afeta links emitidos depois. Toda consulta emite links novos.
- PDF sob demanda:
danfe,danfce,dacte,daceedanfsesão renderizados no primeiro download, então o link já é utilizável no momento em que o documento é autorizado. Se a renderização ainda não terminou, a resposta é 503 comRetry-After. - Falhas são status HTTP: 403 quando a aplicação ou o integrador está desativado; o corpo é o envelope da plataforma com
success=false. - Limite de taxa e cobrança: downloads contam no limite da aplicação e têm o próprio grupo
FILES; não são cobrados.
kindTipo do arquivo
| Valores | Significado |
|---|---|
| xml | XML original: documento autorizado ou recibo de evento, por id de arquivo |
| danfe | PDF da DANFE da NF-e, pela chave de 44 dígitos |
| danfce | PDF do cupom da NFC-e em 80 mm, pela chave de 44 dígitos |
| dacce | PDF da carta de correção (DACCE), por id de arquivo |
| dacte | PDF do DACTE do CT-e, pela chave de 44 dígitos |
| dace | PDF do DACE do DC-e, pela chave de 44 dígitos |
| danfse | PDF da DANFSe da NFS-e, pela chave de 50 dígitos ou pelo identificador da DPS |
| Código | HTTP | |
|---|---|---|
| 10009035 | 401 | Token inválido: assinatura não confere, link alterado ou reutilizado em outro arquivo, ou o aplicativo que o emitiu não existe mais. |
| 10009035 | 404 | Link inexistente: kind desconhecido, ou ref de um link xml que não é um identificador de arquivo. |
| 10009036 | 401 | Link expirado. Consulte o documento novamente para obter um link novo. |
| 10009004 | 403 | Aplicativo desativado: todos os links que ele emitiu deixam de funcionar. |
| 10009015 | 403 | Aplicativo ainda não vigente (aguardando aprovação ou recusado). |
| 10009014 | 403 | Integrador desativado. |
| 10004001 | 404 | NF-e do link não existe (DANFE). |
| 10017003 | 404 | CT-e do link não existe (DACTE). |
| 10019003 | 404 | DC-e do link não existe (DACE). |
| 10018003 | 404 | NFS-e do link não existe (DANFSe). |
| 10022006 | 404 | NFC-e do link não existe (cupom). |
| 10013011 | 404 | Arquivo não encontrado (XML). |
| 10004010 | 409 | NF-e não autorizada: não há DANFE. mensagem traz a situação atual. |
| 10017046 | 409 | Situação atual do CT-e não permite DACTE. |
| 10019046 | 409 | Situação atual da DC-e não permite DACE. |
| 10018060 | 409 | Situação atual da NFS-e não permite DANFSe. |
| 10022012 | 409 | Situação atual da NFC-e não permite cupom: só Autorizada, Cancelada e ContingenciaPendente têm. |
| 10013013 | 409 | Arquivo indisponível no momento (arquivado, em quarentena ou expirado). |
| 10009006 | 429 | Limite de chamadas do aplicativo excedido. Repita após Retry-After. |
| 10013016 | 429 | Downloads em excesso a partir de um mesmo IP, para links sem aplicativo (os que chegam por webhook). Repita após Retry-After. |
| 10009037 | 503 | Documento ainda sendo gerado. Repita o mesmo link após Retry-After (30 s). |
