文件
文件下载
通过查询与回调返回的链接下载 XML 原件或单据 PDF。
GET
/openapi/files/{kind}/{ref}无需签名头。
查询响应与回调载荷中的下载链接形如 https://api.v2.tffiscal.com/openapi/files/{kind}/{ref}?token=…。无需签名头:令牌随链接携带,直接 GET 即可。令牌与路径、集成商、应用绑定;改动路径或复用到其他文件都会失效。请原样使用返回的链接。
路径参数
kind* | string | 文件类型 |
ref* | string | 文件引用 |
* 必填字段
查询参数
token* | string | 链接令牌 |
* 必填字段
302
重定向到 60 秒内有效的对象存储 URL。客户端必须跟随重定向(
curl -L)。响应带 Cache-Control: no-store,请勿缓存链接。无响应体
- 有效期:默认 7 天;平台可按集成商配置 1 到 365 天,配置只影响之后签发的链接。每次查询都会签发新链接。
- PDF 按需渲染:
danfe、danfce、dacte、dace、danfse在首次下载时渲染,所以单据一授权链接就可用。渲染尚未完成时回 503 并带Retry-After。 - 失败以 HTTP 状态表达:应用或集成商被停用时回 403;响应为平台统一响应体,
success=false。 - 限流与计费:下载计入应用限流并有独立的
FILES分组;不计费。
kind文件类型
| 取值 | 含义 |
|---|---|
| xml | XML 原件:授权单据或事件回执,按文件 id |
| danfe | NF-e 的 DANFE PDF,按 44 位密钥 |
| danfce | NFC-e 的 80mm 小票 PDF,按 44 位密钥 |
| dacce | 更正函凭证 DACCE 的 PDF,按文件 id |
| dacte | CT-e 的 DACTE PDF,按 44 位密钥 |
| dace | DC-e 的 DACE PDF,按 44 位密钥 |
| danfse | NFS-e 的 DANFSe PDF,按 50 位密钥或 DPS 标识 |
| 错误码 | HTTP | |
|---|---|---|
| 10009035 | 401 | 令牌无效:签名不符、链接被改动或被复用到其他文件,或签发它的应用已不存在。 |
| 10009035 | 404 | 链接不存在:kind 不认识,或 xml 链接的 ref 不是文件标识。 |
| 10009036 | 401 | 下载链接已过期。重新查询单据即可拿到新链接。 |
| 10009004 | 403 | 应用已停用:它签发的所有链接一并失效。 |
| 10009015 | 403 | 应用未生效:待审批或已驳回。 |
| 10009014 | 403 | 集成商已停用。 |
| 10004001 | 404 | 链接指向的 NF-e 不存在(DANFE)。 |
| 10017003 | 404 | 链接指向的 CT-e 不存在(DACTE)。 |
| 10019003 | 404 | 链接指向的 DC-e 不存在(DACE)。 |
| 10018003 | 404 | 链接指向的 NFS-e 不存在(DANFSe)。 |
| 10022006 | 404 | 链接指向的 NFC-e 不存在(小票)。 |
| 10013011 | 404 | 文件不存在(XML)。 |
| 10004010 | 409 | NF-e 未授权,没有 DANFE。mensagem 给出当前状态。 |
| 10017046 | 409 | CT-e 当前状态不能出具 DACTE。 |
| 10019046 | 409 | DC-e 当前状态不能出具 DACE。 |
| 10018060 | 409 | NFS-e 当前状态不能出具 DANFSe。 |
| 10022012 | 409 | NFC-e 当前状态不能出具小票:只有 Autorizada、Cancelada、ContingenciaPendente 可以。 |
| 10013013 | 409 | 文件当前不可用:已归档、隔离或过期。 |
| 10009006 | 429 | 超出应用的调用频率上限。按 Retry-After 重试。 |
| 10013016 | 429 | 同一 IP 下载过于频繁,针对不带应用的链接(经 Webhook 下发的那种)。按 Retry-After 重试。 |
| 10009037 | 503 | 凭证还在生成。按 Retry-After(30 秒)稍后重试同一链接。 |
