Pular para o conteúdo principal

Obter comprovante do Vale-Pedágio

Fornece o comprovante da operação de vale-pedágio em formato PDF, convertido em Base64, para que o cliente possa visualizar ou armazenar o documento.

Método e rota

  • Consulta (GET): /valePedagio/obterComprovanteVP/{enterpriseID}/{cnpj}/{ndvp}/{cod}
    • {cnpj}: CNPJ associado à operação.
    • {ndvp}: Número ou identificador NDVP do vale-pedágio.
    • {cod}: Código verificador do NDVP.

Estrutura da requisição

Cabeçalhos

  • Authorization: o token JWT deve ser enviado no header.

    Authorization: Bearer {token}

Validações e regras de negócio

  1. **1. Requisição:
    • O cliente envia uma requisição GET para a rota /valePedagio/obterComprovanteVP/{enterpriseID}/{cnpj}/{ndvp}/{cod} com os parâmetros de rota e o token JWT no header.
  2. Processamento:
    • O servidor valida os parâmetros e o token JWT.
    • Em seguida, o servidor recupera o comprovante da operação de vale-pedágio em formato PDF, o converte para Base64 e retorna esse conteúdo no campo pdf do JSON.
  3. Resposta:
    • Em caso de sucesso, o comprovante em Base64 é retornado conforme o exemplo de resposta.
    • Em caso de erro, a resposta segue o padrão de erro estabelecido (por exemplo, com código 400, 401 ou 500 e uma mensagem descritiva).

Resposta do POST

O endpoint retornará um JSON com a seguinte estrutura:

{
"pdf": "base64 do pdf do comprovante"
}
  • pdf: (string) Representa o comprovante da operação de vale-pedágio em formato PDF codificado em Base64.

Códigos de Status HTTP

  • 200 ou 201: Consulta realizada com sucesso, e o comprovante é retornado.
  • 400: Erro de validação (por exemplo, parâmetros da rota ausentes ou inválidos).
  • 401: Não autorizado (token JWT ausente ou inválido).
  • 500: Erro interno do servidor.