Veículos por placa (device-based): POST /vehicles/{action}.
Além das funções nomeadas, request/4 aceita qualquer action do catálogo e
queue/4 executa a mesma action por fila.
{:ok, envelope} = ApiBrasil.Data.Vehicles.dados(client, %{"placa" => "ABC1234"})
ApiBrasil.Core.DeviceResponse.response(envelope)Summary
Functions
Base nacional: POST /vehicles/base/000/dados.
Como base_dados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
FIPE na base nacional: POST /vehicles/base/000/fipe.
Como base_fipe/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta a FIPE por placa na rota dedicada:
POST /vehicles/consultafipe/{placa}.
Como consulta_fipe/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Dados do veículo pela placa: POST /vehicles/dados — body %{"placa" => "..."}.
Como dados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
FIPE pela placa: POST /vehicles/fipe — body %{"placa" => "..."}.
Como fipe/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Executa a action de forma assíncrona, por fila: POST /vehicles/{action}/queue.
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Executa qualquer action do serviço: POST /vehicles/{action}.
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Serviço do gateway coberto por este módulo: vehicles.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec base_dados(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Base nacional: POST /vehicles/base/000/dados.
@spec base_dados!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como base_dados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec base_fipe(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
FIPE na base nacional: POST /vehicles/base/000/fipe.
@spec base_fipe!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como base_fipe/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec consulta_fipe(ApiBrasil.Client.t(), String.t(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta a FIPE por placa na rota dedicada:
POST /vehicles/consultafipe/{placa}.
@spec consulta_fipe!(ApiBrasil.Client.t(), String.t(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como consulta_fipe/3, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec dados(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Dados do veículo pela placa: POST /vehicles/dados — body %{"placa" => "..."}.
@spec dados!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como dados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec fipe(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
FIPE pela placa: POST /vehicles/fipe — body %{"placa" => "..."}.
@spec fipe!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como fipe/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec queue(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Executa a action de forma assíncrona, por fila: POST /vehicles/{action}/queue.
@spec queue!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec request(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Executa qualquer action do serviço: POST /vehicles/{action}.
As actions conhecidas estão em
ApiBrasil.Generated.Catalog.service_actions("vehicles"); a
documentação completa fica em https://doc.apibrasil.io.
@spec request!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec service() :: String.t()
Serviço do gateway coberto por este módulo: vehicles.