Histórico da Página

...

Deck of Cards

id	apirest

Card

label	Método POST- Parâmetros de entrada

Bloco de código

theme	RDark
firstline	1
title	Exemplo body - JSON
linenumbers	true
collapse	true

{
   "entidade":"000001",
   "serie":"111",
   "numero":"111111111",
   "modelo":"55"
}

Estrutura esperada
Campo	Tipo	Tamanho	Observação
entidade	string	6	Entidade utilizada pela empresa no TSS.
serie	string	3	Série do documento.
numero	string	9	Número do documento.
modelo	string	2	Modelo do documento. Exemplo: NF-e: 55.

Card

label	Método POST - Parâmetros de saída

Deck of Cards

id	Retornos API

Card

label	Sucesso

Bloco de código

theme	RDark
firstline	1
title	Exemplo de retorno - Sucesso - JSON
linenumbers	true
collapse	true

{
    "status": 200,
    "message": "sucesso",
    "data": [
        {
            "xml": "XMLDANFE_BASE64",
            "danfe": "DANFE_BASE64"
        }
    ]
}

Card

label	Falha

Bloco de código

theme	RDark
firstline	1
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
   "status":400,
   "message":"Erro na estrutura do json",
   "data":[
      
   ]
}

Estrutura - JSON
Campo	Tipo	Estrutura pai	Descrição	Observação
status	Numérico	-	Código de status de retorno.	Sucesso: 200 Falha: 400
message	String	-	Indica se a requisição foi bem-sucedida.	Em caso de retorno positivo: sucesso Em caso de retorno negativo: Mensagem com a descrição do erro.
data	Vetor	-	Vetor contendo as informações de retorno da requisição.	Retorna vazio em caso de falha.
xml	String	data	Retorna o arquivo XML da requisição encodado em BASE64.	Retornado apenas em caso de sucesso.
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
Erro na estrutura do JSON	Validar se a estrutura confere com o modelo esperado JSON
Falha criacao de arquivo	Validar acesso a pastas.
Registro nao localizado na SPED050	Validar se os dados informados na requisição estão vinculados a um registro existente na tabela SPED050
Dado incorreto: *campo* , tamanho esperado *tamanho*	Tamanho do campo informado na requisição maior que o esperado.
Dado incorreto: *campo, esperado caractere*	Dado informado no campo, foi diferente de string.
Estrutura incorreta parte faltante *campo*	Validar se todos os campos necessários foram informados na requisição.

...

Páginas filhas

Versões comparadas

Versão antiga 30

Nova versão 31

Chave