Páginas filhas
  • DANFEAPI - API REST para retorno de DANFE encodado.

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tabelas utilizadas
  4. 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
idapirest
Card
labelMétodo POST- Parâmetros de entrada
Bloco de código
themeRDark
firstline1
titleExemplo body
linenumberstrue
collapsetrue
[{"modalidade": 1,
"signXml":"XML DA NFE ENCODADO EM BASE64",
"protXml" : "XMLPROT ENCODADO EM BASE64"
}]
Estrutura esperada
CampoTipoTamanhoObservação
modalidadenumeric1Modalidade da nota.
signXmlstring-XML da NF-e encodado em base64.
protXmlstring-XMLProt da NF-e encodado em base64.



Card
labelMétodo POST - Parâmetros de saída
Deck of Cards
idRetornos API
Card
labelSucesso
Bloco de código
themeRDark
firstline1
titleExemplo de retorno - Sucesso
linenumberstrue
collapsetrue
{
  "danfe":"Retorna o DANFE da NF-e encodado"
}
Card
labelFalha
Bloco de código
themeRDark
firstline1
titleExemplo de retorno - Falha
linenumberstrue
collapsetrue
{
   "status":400,
   "message":"Invalid Request."
}
Estrutura - JSON
CampoTipoEstrutura paiDescriçãoObservação
statusNumérico-Código de status de retorno.

Sucesso: 200

Falha: 400-500

messageString-Indica se a requisição foi bem-sucedida. 

Em caso de retorno negativo: Mensagem com a descrição do erro.

danfeStringdataRetorna o arquivo DANFE da requisição encodado em BASE64.Retornado apenas em caso de sucesso.
Card
labelMétodo POST - Retornos
Retorno de sucesso possíveis
DescriçãoObservação
SucessoEstrutura completa com os dados requeridos
Retorno de erro possíveis 
DescriçãoObservação
Internal Server Error.Falha na criação do arquivo PDF.
Invalid RequestDados 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

...