CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Tabelas utilizadas
- Informações relacionadas
01. VISÃO GERAL
Essa API tem como função retornar o DANFE de um determinado documento, esses dados são encodados em base64.
02. EXEMPLO DE UTILIZAÇÃO
2.1 Namespace da API
...
Deck of Cards |
---|
|
Card |
---|
label | Método POST- Parâmetros de entrada |
---|
| Bloco de código |
---|
theme | RDark |
---|
firstline | 1 |
---|
title | Exemplo body |
---|
linenumbers | true |
---|
collapse | true |
---|
| [{"modalidade": 1,
"signXml":"XML DA NFE ENCODADO EM BASE64",
"protXml" : "XMLPROT ENCODADO EM BASE64"
}] |
Estrutura esperada |
---|
Campo | Tipo | Tamanho | Observação | modalidade | numeric | 1 | Modalidade da nota. | signXml | string | - | XML da NF-e encodado em base64. | protXml | string | - | XMLProt da NF-e encodado em base64. |
|
Card |
---|
label | Método POST - Parâmetros de saída |
---|
| Deck of Cards |
---|
| Card |
---|
| Bloco de código |
---|
theme | RDark |
---|
firstline | 1 |
---|
title | Exemplo de retorno - Sucesso |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"danfe":"Retorna o DANFE da NF-e encodado"
} |
|
Card |
---|
| Bloco de código |
---|
theme | RDark |
---|
firstline | 1 |
---|
title | Exemplo de retorno - Falha |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"status":400,
"message":"Invalid Request."
} |
|
|
Estrutura - JSON |
---|
Campo | Tipo | Estrutura pai | Descrição | Observação | status | Numérico | - | Código de status de retorno. | Sucesso: 200 Falha: 400-500 | message | String | - | Indica se a requisição foi bem-sucedida. | Em caso de retorno negativo: Mensagem com a descrição do erro. | danfe | String | data | Retorna o arquivo DANFE da requisição encodado em BASE64. | Retornado apenas em caso de sucesso. |
|
Card |
---|
label | Método POST - Retornos |
---|
| Retorno de sucesso possíveis |
---|
Descrição | Observação | Sucesso | Estrutura completa com os dados requeridos |
Retorno de erro possíveis |
---|
Descrição | Observação | Internal Server Error. | Falha na criação do arquivo PDF. | Invalid Request | Dados enviados estão incorretos. Podendo não estar encodado, parte faltante ou tipo do campo diferente do esperado. |
|
|
03. TABELAS UTILIZADAS
SPED050.
04. Informações relacionadas
- Para o uso da API é necessário que o arquivo Printer.exe, esteja na pasta do AppServer do TSS.
- Configuração do REST: Configuração REST
- Gravação de logs TSS: Gravação de logs da API - TSS