Objetivo
Fazer o encerramento de um MDFe.
1. Obter token autenticação
Introdução
Qualquer webservice do projeto SispetroWeb exigirá um token de autenticação. Este token é gerado a partir deste webservice e será válido por 24 horas. Assim, recomendamos que o sistema consumidor dos webservices aqui descritos salvem o token armazenando também a data e hora em que ele foi gerado para que, quando chegar próximo de sua validade, seja obtido novo token.
Para mais informações, ver Documentação - API Obtenção de Token
2. Encerramento MDFe
Introdução
Este webservice tem por finalidade o encerramento de um MDFe conforme seu Id. Ele realiza todo o processamento junto a SEFAZ e retorna um status 200 caso tenha conseguido realizar o encerramento ou status 403 com algum descritivo do erro.
Para que essa API funcione, o usuário deve ser o papel de motorista habilitado (usuários, aba SispetroApp, grupo Papel Motorista).
Além disso, somente MDFes com o campo StatusProcessamento = 4 (pendente encerramento) serão válidos para encerramento.
Endereço
<endereço do SispetroWeb>/mdfe/solicita_encerramento
Parâmetros
Será necessário enviar um header com o token e no corpo do webservice o id do MDFe que se deseja encerrar.
Headers
Nome | Descritivo | Exemplo | Observações |
|---|---|---|---|
Authorization | Conteúdo do token obtido no passo de autenticação do usuário | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAxLjgwNC4zNDUvMDAwMS02MCIsImV4cCI6MTUwMDA1MzYxN30.-ZvhWFYI8fyx66b3kZY1UVUrfaWUTioV3_M6K2wiPGM |
|
Content-Type | tipo do formato de envio | application/json |
|
Accept | tipo do formato de envio | application/json |
|
Body
Layout abaixo em formato JSON.
Item | Chave | Conteudo | Pai | Obrigatório |
|---|---|---|---|---|
1 | id | Número do ID na tabela MDFe do MDFe | - | Sim |
Método
POST
Exemplo de chamada de WebService
curl -H "Content-Type: application/json" -H "Accept: application/json" -X POST -H "Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAxLjgwNC4zNDUvMDAwMS02MCIsImV4cCI6MTUwMDA1MzYxN30.-ZvhWFYI8fyx66b3kZY1UVUrfaWUTioV3_M6K2wiPGM" http://localhost/mdfe/solicita_encerramento -d '{"id":"8383"}'
Retorno Bem Sucedido
Será retornado um objeto JSON com o registro do MDFe encerrado e o status 200. O status da resposta sempre será 200.
{"resultado": "ordem carregamento processada com sucesso","status":200}
Retorno Sem Sucesso
Será retornado um objeto JSON com o motivo do não processamento (poderá ser um erro de autenticação caso o token tenha expirado ou seja inválido ou alguma regra de negócio não atendida. O status da resposta sempre será diferente de 200.
{"error":"MDFe não encontrado ou com status inválido para encerramento","status":422}