Dúvida
API de Recebimento DF-e
Procedimento
Esta documentação tem por objetivo detalhar o processo de configuração da API de Recebimento DF-e.
Configurações de Recebimento
1. Definir se deseja salvar uma cópia do XML recebido via API. Definir o diretório do XML e em seguida definir a inclusão automática do documento após Recebimento dia API:
Configurações do Serviço
2. Iniciar o Serviço de Recebimento API:
- Definir a porta da API que, por padrão, será 5001;
- Gerar o token de autenticidade da API;
- Salvar configurações.
Exemplo de comunicação com Postman
Método POST
3. Informar a URL, o tipo de autorização e o token gerado no serviço:
4. Em seguida, habilite o parâmetro XML e informe o XML de recebimento:
5. Exemplo de comunicação C#.
using RestSharp;
static void Main(string[] args)
{
var url = "http://localhost:5000";
var token = "ad934a48-7b6f-43b0-9baa-533906ae9284";
var xml = File.ReadAllText(@"C:\Users\Invent\Desktop\xmlEntrada\entrada.xml");
var restClient = new RestClient(url);
var request = new RestRequest("/api/recepcionar/entrada", Method.POST)
{
RequestFormat = DataFormat.Xml,
XmlSerializer = new RestSharp.Serializers.DotNetXmlSerializer()
};
request.AddHeader("Authorization", token);
request.AddParameter("xml", xml, ParameterType.QueryString);
var response = restClient.Post(request);
Console.WriteLine(response.Content);
Console.ReadKey();
}6. Retorno do Envio:
<RetornoRecebimento>
<Sucesso>true</Sucesso>
<Mensagem>Documento [53201212769092000158550510000010601489428191]
recebido com sucesso.</Mensagem>
</RetornoRecebimento>Para realizar a emissão de manifestos via API, é necessário realizar a configuração da requisição e informar os dados abaixo, quando exigidos pelo tipo de manifesto:
Eventos contemplados
A API permite o registro dos seguintes eventos:
Confirmação da Operação;
Desconhecimento da Operação;
Ciência da Operação;
Operação não Realizada;
Prestação do Serviço em Desacordo (CT-e).
Informações necessárias
ID do documento
Chave de acesso
Número do tipo de evento, conforme definido pela SEFAZ
Justificativa, quando aplicável
Importante: para que o processo funcione corretamente, o documento já deve ter sido capturado pelo DFe e estar disponível na tela de Administração do Add-on.
Configuração no Postman
Body → raw
As informações do manifesto devem ser preenchidas no corpo da requisição, utilizando a opção raw.
{
"documentoId": 0,
"chave": 35260537733991000393576000000000461315667004,
"evento": 210210,
"justificativa": 0
}
Params
Na aba Params, deve ser informada a chave de acesso do documento.
Headers
Na aba Headers, deve ser informado o Token gerado nos serviços do Add-on DFe.
Após realizar essas configurações, a requisição poderá ser enviada para processamento do manifesto via API.
