curl --request POST \
--url https://api.mobway.cloud/vehicle-data \
--header 'Authorization: Bearer <token>' \
--data '{
"vins": [
{vins}
],
"datapoints": [
"vin",
"date_time",
"speed",
"latitude",
"longitude",
"heading",
"rpm",
"odometer",
"fuel_level",
"range",
"left_front_tire_pressure",
"right_front_tire_pressure",
"left_rear_tire_pressure",
"right_rear_tire_pressure",
"oil_level",
"engine_cooling_temperature",
"lv_battery_voltage",
"hv_battery_voltage",
"hv_battery_soc",
"hv_battery_charging_status",
"seat_belt_status",
"event",
"flag"
],
"start_date": {start_date},
"end_date": {end_date}
}'
{
"6AHFT68CKAF501652": [
{
"vin": "6AHFT68CKAF501652",
"date_time": "2023-02-14 09:51:48",
"speed": 109.78,
"latitude": 56.073055,
"longitude": -177.689265,
"heading": 357.92,
"rpm": 3737.16,
"odometer": 806942.06,
"fuel_level": 79.79,
"range": -75.68,
"left_front_tire_pressure": 31.66,
"right_front_tire_pressure": 31.95,
"left_rear_tire_pressure": 31.17,
"right_rear_tire_pressure": 31.88,
"oil_level": 15.28,
"engine_cooling_temperature": 11.4,
"lv_battery_voltage": 12.41,
"hv_battery_voltage": 596.41,
"hv_battery_soc": 38.48,
"hv_battery_charging_status": "other",
"seat_belt_status": "not buckled",
"event": "charging plug status change",
"flag": {}
},
{
"vin": "6AHFT68CKAF501652",
"date_time": "2023-02-14 09:51:51",
"speed": 265.23,
"latitude": 56.089004,
"longitude": -177.71086,
"heading": 357.92,
"rpm": 5591.89,
"odometer": 806942.21,
"fuel_level": 21.35,
"range": -76.13,
"left_front_tire_pressure": 31.66,
"right_front_tire_pressure": 31.95,
"left_rear_tire_pressure": 31.17,
"right_rear_tire_pressure": 31.88,
"oil_level": 95.38,
"engine_cooling_temperature": 129.52,
"lv_battery_voltage": None,
"hv_battery_voltage": None,
"hv_battery_soc": 17.87,
"hv_battery_charging_status": "charging",
"seat_belt_status": "not buckled",
"event": "charging plug status change",
"flag": {
"lv_battery_voltage": {
"value": 35.44,
"flag": "out of range"
},
"hv_battery_voltage": {
"value": 1200.54,
"flag": "out of range"
}
}
}
]
}
Endpoint
POST vehicle-data
Retorna os dados dos veículos conectados à empresa
POST
/
vehicle-data
curl --request POST \
--url https://api.mobway.cloud/vehicle-data \
--header 'Authorization: Bearer <token>' \
--data '{
"vins": [
{vins}
],
"datapoints": [
"vin",
"date_time",
"speed",
"latitude",
"longitude",
"heading",
"rpm",
"odometer",
"fuel_level",
"range",
"left_front_tire_pressure",
"right_front_tire_pressure",
"left_rear_tire_pressure",
"right_rear_tire_pressure",
"oil_level",
"engine_cooling_temperature",
"lv_battery_voltage",
"hv_battery_voltage",
"hv_battery_soc",
"hv_battery_charging_status",
"seat_belt_status",
"event",
"flag"
],
"start_date": {start_date},
"end_date": {end_date}
}'
{
"6AHFT68CKAF501652": [
{
"vin": "6AHFT68CKAF501652",
"date_time": "2023-02-14 09:51:48",
"speed": 109.78,
"latitude": 56.073055,
"longitude": -177.689265,
"heading": 357.92,
"rpm": 3737.16,
"odometer": 806942.06,
"fuel_level": 79.79,
"range": -75.68,
"left_front_tire_pressure": 31.66,
"right_front_tire_pressure": 31.95,
"left_rear_tire_pressure": 31.17,
"right_rear_tire_pressure": 31.88,
"oil_level": 15.28,
"engine_cooling_temperature": 11.4,
"lv_battery_voltage": 12.41,
"hv_battery_voltage": 596.41,
"hv_battery_soc": 38.48,
"hv_battery_charging_status": "other",
"seat_belt_status": "not buckled",
"event": "charging plug status change",
"flag": {}
},
{
"vin": "6AHFT68CKAF501652",
"date_time": "2023-02-14 09:51:51",
"speed": 265.23,
"latitude": 56.089004,
"longitude": -177.71086,
"heading": 357.92,
"rpm": 5591.89,
"odometer": 806942.21,
"fuel_level": 21.35,
"range": -76.13,
"left_front_tire_pressure": 31.66,
"right_front_tire_pressure": 31.95,
"left_rear_tire_pressure": 31.17,
"right_rear_tire_pressure": 31.88,
"oil_level": 95.38,
"engine_cooling_temperature": 129.52,
"lv_battery_voltage": None,
"hv_battery_voltage": None,
"hv_battery_soc": 17.87,
"hv_battery_charging_status": "charging",
"seat_belt_status": "not buckled",
"event": "charging plug status change",
"flag": {
"lv_battery_voltage": {
"value": 35.44,
"flag": "out of range"
},
"hv_battery_voltage": {
"value": 1200.54,
"flag": "out of range"
}
}
}
]
}
Apesar de ser uma requisição POST, está rota não se destina a criar um recurso na API. Foi desenvolvida desta forma pela comodidade de customizar o payload a ser enviado no corpo da requisição.
Request
Header
string
obrigatório
É o token ao portador utilizado para autenticar a empresa.
Body
list of strings
obrigatório
Indica a lista de Vehicle Identification Number (VIN) dos veículos os quais se deseja recuperar os dados.
- A quantidade de VINs deve ser no máximo 20
list of strings
obrigatório
Indica a lista de pontos de dados que se deseja recuperar dos veículos.
date or datetime
É um parâmetro opcional e pode ser usado para filtrar a data de início dos dados. Deve ser enviado nos seguintes formatos:
- YYYY-MM-DD Para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDT00:00:00-03:00 (UTC-3)
- YYYY-MM-DDTHH:MM:SS Para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDTHH:MM:SS-03:00 (UTC-3)
- YYYY-MM-DDTHH:MM:SS-ZZ:00 Para os propósitos do filtro, será considerado exatamente o horário informado: YYYY-MM-DDTHH:MM:SS-ZZ:00 (UTC-Z)
date or datetime
Também é um parâmetro opcional e pode ser usado para filtrar a data de fim dos dados. Deve ser enviado nos seguintes formatos:
- YYYY-MM-DD Para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDT00:00:00-03:00 (UTC-3)
- YYYY-MM-DDTHH:MM:SS Para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDTHH:MM:SS-03:00 (UTC-3)
- YYYY-MM-DDTHH:MM:SS-ZZ:00 Para os propósitos do filtro, será considerado exatamente o horário informado: YYYY-MM-DDTHH:MM:SS-ZZ:00 (UTC-Z)
- Quando forem utilizados start_date e end_date, o date_time estará entre estas duas datas, da seguinte forma: end_data >= datetime >= start_date
- Quando não forem utilizados o start_date e o end_date, será requisitado, por padrão, as últimas 24 horas a partir do momento da atual
- Quando for utilizado apenas o start_date, o end_date será considerado, por padrão, como start_date mais 24 horas
- Quando for utilizado apenas o end_date, o start_date será considerado, por padrão, como end_date menos 24 horas
- O valor mínimo para o start_date é do momento atual menos sete dias
- O valor máximo para o end_date é o momento atual
- A diferença entre o start_date e end_date deve ser de no máximo 24 horas
Response
Para informações mais detalhadas sobre a resposta, consultar em Pontos de Dados
string
Indica o número de identificação único do veículo.
datatime
Indica a data e hora do registro do conjunto de dados [YYYY-MM-DD HH:MM:SS].
number or categorical
Indica separademente cada pontos de dados.
categorical
Indica quando um dado foi considerado como errôneo e foi corrigido, contendo o dado do qual se trata, o valor original e o tipo do erro.
- “VIN not found or unauthorized access.”: O VIN solicitada é inválido ou não está associada à sua empresa. Verifique o VIN ou suas permissões.
- “Unsupported datapoint for this vehicle.”: O ponto de dado solicitado não está disponível para este veículo devido a restrições de compatibilidade com o OEM.
- “Datapoint not included in your package plan.”: O ponto de dado solicitado não está disponível no seu plano atual. Entre em contato com o suporte da mobway para mais assistência.
- “No data for the given date range: start_date to end_date.”: Nenhum dado foi encontrado para o intervalo de datas informado (start_date a end_date). Verifique se as datas estão corretas, confira o fuso horário ou tente selecionar um período diferente.
- “start_date is greater than end_date.”: A data inicial (start_date) é posterior a data final (end_date) informada.
- “start_date or end_date are out of the range of 7 days.”: As datas inicial ou final (start_date ou end_date) informadas são anteriores ao período máximo de 7 dias de disponibilidade.
- “start_date or end_date are in the future.”: As datas inicial ou final (start_date ou end_date) informadas são posteriores ao momento atual.
- “Difference between start_date and end_date cannot exceed 24 hours.”: A diferença entre o start_date e end_date é maior que 24 horas
- “Too many VINs provided. Maximum allowed is 20.”: A quantidade de VINs é maior que 20
curl --request POST \
--url https://api.mobway.cloud/vehicle-data \
--header 'Authorization: Bearer <token>' \
--data '{
"vins": [
{vins}
],
"datapoints": [
"vin",
"date_time",
"speed",
"latitude",
"longitude",
"heading",
"rpm",
"odometer",
"fuel_level",
"range",
"left_front_tire_pressure",
"right_front_tire_pressure",
"left_rear_tire_pressure",
"right_rear_tire_pressure",
"oil_level",
"engine_cooling_temperature",
"lv_battery_voltage",
"hv_battery_voltage",
"hv_battery_soc",
"hv_battery_charging_status",
"seat_belt_status",
"event",
"flag"
],
"start_date": {start_date},
"end_date": {end_date}
}'
{
"6AHFT68CKAF501652": [
{
"vin": "6AHFT68CKAF501652",
"date_time": "2023-02-14 09:51:48",
"speed": 109.78,
"latitude": 56.073055,
"longitude": -177.689265,
"heading": 357.92,
"rpm": 3737.16,
"odometer": 806942.06,
"fuel_level": 79.79,
"range": -75.68,
"left_front_tire_pressure": 31.66,
"right_front_tire_pressure": 31.95,
"left_rear_tire_pressure": 31.17,
"right_rear_tire_pressure": 31.88,
"oil_level": 15.28,
"engine_cooling_temperature": 11.4,
"lv_battery_voltage": 12.41,
"hv_battery_voltage": 596.41,
"hv_battery_soc": 38.48,
"hv_battery_charging_status": "other",
"seat_belt_status": "not buckled",
"event": "charging plug status change",
"flag": {}
},
{
"vin": "6AHFT68CKAF501652",
"date_time": "2023-02-14 09:51:51",
"speed": 265.23,
"latitude": 56.089004,
"longitude": -177.71086,
"heading": 357.92,
"rpm": 5591.89,
"odometer": 806942.21,
"fuel_level": 21.35,
"range": -76.13,
"left_front_tire_pressure": 31.66,
"right_front_tire_pressure": 31.95,
"left_rear_tire_pressure": 31.17,
"right_rear_tire_pressure": 31.88,
"oil_level": 95.38,
"engine_cooling_temperature": 129.52,
"lv_battery_voltage": None,
"hv_battery_voltage": None,
"hv_battery_soc": 17.87,
"hv_battery_charging_status": "charging",
"seat_belt_status": "not buckled",
"event": "charging plug status change",
"flag": {
"lv_battery_voltage": {
"value": 35.44,
"flag": "out of range"
},
"hv_battery_voltage": {
"value": 1200.54,
"flag": "out of range"
}
}
}
]
}