WS360 - Enviar dados de viagem

WS360 - Nosso serviço para envios dos status das viagens

Esta integração tem por objetivo abrir solicitação para apontamentos dos status das viagens. Os apontamentos são “iniciar viagem”, “abortar viagem”, “marcar chegada”.

Clique aqui para ver histórico de versões

Data de atualização	Data de publicação do serviço	Alterações
29/07/2021	29/07/2021	Disponibilização do webservice

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://entregas-api.comprovei.com/v1/stops>

• Método:

  PATCH

Esta integração retorna um protocolo para acompanhamento - WS301

Parâmetros

Exemplo

{
    "route_number":"TesteWS360",
    "route_date" : "2020-02-03",
    "driver" : "65040930160",
    "document_keys":[
        "12345678901234567890123456789012345678901231",
        "12345678901234567890123456789012345678901232",
        "12345678901234567890123456789012345678901233"
    ],
    "coordinates" : {
        "latitude" : -23.6883,
        "longitude" : -46.7075
    },
    "action_code":"ontheway",
    "datetime":"2021-08-01 09:34:54"
}

Parâmetro	Tipo	Descrição
route_number	Alfanumérico	Código dado à rota no Comprovei (opcional)
route_date	Data	Data da rota no Comprovei (opcional)
driver	Alfanumérico	Motorista atribuído à rota no Comprovei (opcional)
document_keys	Alfanumérico []	Chave do(s) documento(s) (obrigatório)
coordinates	Array	Latitude e Longitude do motorista (Obrigatório)
action_code	Alfanumérico	Código do status (obrigatório) ontheway - A caminho arrive - Chegou no cliente abort - Viagem abortada
datetime	Alfanumérico	Data e hora da ocorrência (obrigatório)
device_id	Alfanumérico	ID do celular do motorista (opcional)
device_model	Alfanumérico	Modelo do celular do motorista (opcional)

Coordinates

Parâmetro	Tipo	Descrição
latitude	Numérico	(Obrigatório) Latitude do local do evento no formato fracionário usando notação americana
longitude	Numérico	(Obrigatório) Longitude do local do evento no formato fracionário usando notação americana

Importante

Todos os campos opcionais serão validados caso sejam enviados, ou seja não podem estar em branco, caso não deseje enviar as informações opcionais, não acrescente os campos.

• Sucesso:

  • Código: 202
    Conteúdo:

    {
        "message" : "OK",
        "protocol" : "<protocol>"
    }
    

• Erro:

  • Código: 400
    Conteúdo:

    {
        "message": "Corpo da requisição está vazio"
    }
    

    {
        "message" : "Rota não encontrada" 
    }
    

    {
        "message" : "Ação inválida" 
    }
    

    { 
        "message" : "Campos obrigatórios não preenchidos" 
    }