Pular para conteúdo

WS605 - Exportar paradas

Esta integração tem por objetivo exportar o relatório de paradas do Comprovei

Autenticação

  • As chamadas terão autenticação a nível de transporte (Basic Authentication);
  • Solicite o user / password ao administrador da conta.

Características

  • URL

    https://api.comprovei.com.br/api/1.1/util/export/documentStop

  • Método:

    POST

  • Parâmetro URL:

    Sem parâmetros

  • Exemplo: 

    {
    "headers": {
        "username": "usuario",
        "password": "senha"
    },
    "body": {
        "formato_exportacao" : "xml",
        "filtros": {
            "data_inicial": "2020-01-01",
            "data_final": "2020-01-01",
            "data_emissao_inicial": "2020-01-01",
            "data_emissao_final": "2020-01-01",
            "numero_rota": ["String", "String2"],
            "status_rota":[3, 4],
            "tipo_rota": ["int","int2"],
            "tipo_documento": ["String", "String2"],
            "motorista":["String", "String2"],
            "transportadoras":["String", "String2"],
            "embarcadores":["String", "String2"],
            "placa_veiculo":["String", "String2"],
            "codigo_transportador":["String", "String2"],
            "regioes":["String", "String2"],
            "numero_documento": ["String", "String2"],
            "chave_documento": ["String","String2"],
            "embarcadores": ["String", "String2"]
        },
        "campos": [
            "Data Emissão",
            "CD",
            "Rota/Roteiro",
            "Parada",
            "Motorista",
            "Placa",
            "Transportadora Responsável",
            "Manifesto",
            "Cód. Cliente",
            "Nome Cliente",
            "CNPJ",
            "Ocorrências",
            "Status",
            "Itens",
            "Horário",
            "Endereço",
            "CEP",
            "Bairro",
            "Município/Cidade",
            "Estado",
            "Ajuste Manual",
            "Usuário Ajuste",
            "Distância Percorrida",
            "Peso Bruto",
            "Peso Líquido",
            "Embarcador",
            "Início dentro da cerca",
            "Chegada dentro da cerca",
            "Ocorrência apontada",
            "Intervalo compatível",
            "Qualidade",
            "Tipo de rota",
            "Início planejado da rota",
            "Horário início da rota",
            "Fim planejado da rota",
            "Retorno à base",
            "Pedido",
            "Valor",
            "Cnpj Transp Responsável",
            "Transportadora do Trecho",
            "Cnpj Transp do Trecho",
            "Foto Anotação",
            "SmartScan Anotação",
            "Anotação",
            "Assinatura",
            "Assinatura Nome",
            "Assinatura Documento",
            "Gerente e-mail",
            "Supervisor e-mail",
            "Latitude do Cliente",
            "Longitude do Cliente",
            "Latitude da Chegada",
            "Longitude da Chegada",
            "Just. Atraso Chegada Rota",
            "Just. Atraso Saída Rota",
            "Estimado",
            "Tipo NF",
            "Rota criada por",
            "Tracking",
            "Foto",
            "Tipo de Frete",
            "Hora do Ajuste",
            "Tipo de Cliente",
            "Chave da Nota",
            "CNPJ Emissor",
            "Distância Prevista",
            "Volumes",
            "Remessa",
            "Data Rota",
            "Cód. Motorista",
            "Ordem Prevista",
            "Ordem Executada"
        ],
        "campos_inclusos": [
            "Data Emissão",
            "CD",
            "Rota/Roteiro"
        ]
    }
}

    Importante

    • "campos" é usado para definir os nomes dos campos que devem ser utilizados na exportação. Nenhum campo deve ser adicionado ou retirado, apenas alterados.
    • O campo "campos" não deve ter sua ordem alterada, porém o nome dos campos pode ser alterado para a exportação.
    • Em "campos_inclusos" é possível selecionar quais campos e em que ordem eles serão exportados, os nomes dos campos devem ser iguais ao do campo "campos". Caso queira exportar todos os campos, não acrescentar "campos_inclusos".
    • Em "formato_exportação" é possível selecionar qual modelo da exportação, são aceitos: xml, xls, json e csv;

    Exemplo de Response

    • Sucesso: 
      {
    "statusCode": 200,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "user_message": "https://comprovei.s3.amazonaws.com/producao/report_requests/export/21/routeExport-20200525192526.csv.zip?  X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJELIIV2RATTMVK7A%2F20200525%2Fus-east-1%2Fs3%2Faws4_request&    X-Amz-Date=20200525T192538Z&X-Amz-Expires=259200&   X-Amz-Signature=19d54276cff1a3f1e074bac3e5f7737d670030f5bfb8267fbfebeb335a2dfca4&X-Amz-SignedHeaders=host",
        "code": 0,
        "internal_message": "Exportação gerada com sucesso!",
        "response_data": ""
    }
}

    • Erro: 

      {
    "statusCode": 400,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "message": "Não foram encontrados resultados para os filtros selecionados!"
    }
}

    • Erro:

      {
    "statusCode": 400,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "message": "Algum campo de data está no formato errado. Tente (aaaa-mm-dd)"
    }
}
      • Erro: 
        {
    "statusCode": 400,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "message": "O intervalo de datas não pode ter mais de 31 dias"
    }
}