API de Integração do Gestware Fleet Management com sites de reservas

Elementos necessários para a utilização desta API

Email: Endereço de email de acesso à aplicação
Senha: Senha de acesso à aplicação
API Key: Chave de acesso à API fornecida pela Gestware

URL do Serviço

`https://api.gestware.pt/api/fleet/`

Header do Pedido

Para utilizar os métodos desta API, devem ser enviados os seguintes elementos no Header do pedido:

Authorization:

String de autorização com Email e Hash MD5 da Senha codificados em Base 64, juntamente com a API Key - base64(Email):base64(md5(Senha)):API Key

Accept:

Formato dos dados a receber - application/json ou application/xml

Métodos

^{[ GET Viaturas ]} ^{[ GET Reserva ]} ^{[ POST Reserva ]} ^{[ GET Locais ]} ^{[ GET Combustiveis ]} ^{[ GET Classes ]} ^{[ GET Categorias ]} ^{[ GET Frotas ]}

`GET Viaturas`

Este método pode ser usado para obter todas as viaturas da firma ou obter as viaturas disponíveis durante determinado período, segundo vários critérios.

Argumentos

Sem argumentos:

Este método pode ser usado sem argumentos para obter todas as viaturas da firma

Inicio:

Data e hora de início da disponibilidade datetime - yyyy-MM-d HH:mm

Fim:

Data e hora de fim da disponibilidadedatetime - yyyy-MM-d HH:mm

Local:

Código interno do local onde é efetuada a reserva int

Combustivel:

Código do tipo de combustível string

Classe:

Código da classe string

Categoria:

Código da categoria string

Frota:

Código da frota string

Marca:

Marca/Fabricante string

Modelo:

Modelo string

Lotacao:

Números de lugares smallint

Volume:

Volume máximo de carga decimal

Modelo:

Peso máximo da carga da viaturadecimal

Ano:

Ano da viaturastring

AC:

Ar condicionado bool

Transmissao:

Tipo de transmissão string

Portas:

Número de portas smallint

Malas:

Número de malas smallint

Cilindrada:

Cilindrada decimal

Formato dos dados de Resposta

Ano:

Ano de produção int

Cilindrada:

Cilindrada decimal

CodigoCategoria:

Código da categoria string

CodigoClasse:

Código da classe

CodigoCombustivel:

Código do tipo de combustível

CodigoLocal:

Código interno do local padrão bigint

CodigoTarifaAluguer:

Código da tarifa de aluguer string

CodigoTarifaSeguro:

Código da tarufa do seguro string

Cor:

Cor da viatura string

DepositoGarantia:

Valor do depósito de garantia decimal

DescricaoCategoria:

Descrição da categoria string

DescricaoClasse:

Descrição da classe string

DescricaoCombustivel:

Descrição do tipo de Combustívelstring

DescricaoLocal:

Descrição do local padrão string

TarifaAluguer:

Valor sem IVA da tarifa de aluguer decimal

TaxaIvaTarifaAluguer:

Taxa de IVA (%) a aplicar na tarifa de aluguer decimal

TarifaSeguro:

Valor sem IVA da tarifa do seguro decimal

TaxaIvaTarifaSeguro:

Taxa de IVA(%) a aplicar à tarifa do seguro decimal

Fabricante:

Marca/Fabricante string

Foto:

URL da fotografiastring

Frota:

Código da Frotastring

Franquia:

Valor da franquia decimal

Lotacao:

Número de lugares smallint

Matricula:

Matrícula string

Modelo:

Modelo string

VIN:

Número de identificação da viatura string

PesoMaxCarga:

Peso máximo de carga decimal

VolumeMaxCarga:

Volume máximo de carga decimal

AC:

Ar condicionado bool

MalasViagem:

Número de malas de viagem smallint

NumeroPortas:

Número de portas smallint

Transmissao:

Tipo de transmissão string

CampoLivre1:

Campo Livre 1 string

CampoLivre2:

Campo Livre 2 string

Exemplos

`GET Reserva`

Este método permite criar uma reserva de um cliente para uma viatura.

Argumentos

Numero:

Número da reserva string

Formato dos dados de Resposta

Numero:

Número da reserva string

Data:

Data da reserva datetime

CodigoCliente:

Código do cliente string

Matricula:

Matrícula da viatura string

DataInicial:

Data e hora de início da reserva datetime

DataFinal:

Data e hora de fim da reserva datetime

CodigoLocalInicio:

Código interno do local de levantamento bigint

CodigoLocalFim:

Código interno do local de devolução string

LocalInicio:

Descrição do local de levantamento string

LocalFim:

Descrição do local de devolução string

Estado^[1]:

Estado da reserva string

DataEstado:

Data do estado anterior datetime

Notas:

Notas da reserva string

Franquia:

Valor da franquia decimal

DepositoGarantia:

Valor do depósito de garantia string


            

            ^[1]
            reserva: estado normal de uma reserva;             
            checkin: reserva com check-in efetuado;             
            checkout: reserva com checkout efetuado (viatura devolvida);
            anulado: reserva anulada

Exemplos

`POST Reserva`

Este método permite criar uma reserva de um cliente para uma viatura.

Argumentos

Data^[1]:

Data e hora da reserva datetime - yyyy-MM-d HH:mm

Matricula^[1]:

Matricula da viatura string

Local^[1]:

Código interno do local onde é efetuada a reserva int

LocalInicio^[1]:

Código interno do local de levantamento da viatura int

LocalFim^[1]:

Código interno do local de devolução da viatura int

DataInicio^[1]:

Data e hora de início da reserva datetime - yyyy-MM-d HH:mm

DataFim^[1]:

Data e hora de fim da reserva datetime - yyyy-MM-d HH:mm

Notas:

Notas do cliente para esta reserva string

Código^[2]:

Código do cliente já existente string

Nome^[3]:

Nome do novo cliente string

Morada^[3]:

Morada do novo cliente string

Localidade^[3]:

Localidade do novo cliente string

CodigoPostal^[3]:

Código postal do novo cliente string

Pais^[3]:

Código alfa 2 do país do novo cliente string

Distrito^[3]:

Distrito do novo cliente string

Email:

Endereço de email do novo cliente string

Telefone:

Telefone do novo cliente string

Telemovel:

Telemóvel do novo cliente string

Titulo^[3]:

Título do novo cliente string - Particular ou Empresarial

NIF^[3]:

NIF do novo cliente string


            

            ^[1]
            Campo obrigatório
            

            ^[2]
            Campo obrigatório se o cliente existir
            

            ^[3]
            Campo obrigatório de for um novo cliente

Formato dos dados de Resposta

Valido:

Validade da reserva bool

NumeroReserva:

Número da reserva string

Erros:

Erros encontrados no pedido de criação de reserva string

Exemplos

`GET Locais`

Este método permite obter todos os locais da firma, entre eles os postos ou estações.

Argumentos

Sem argumentos:

Este método não necessita de argumentos.

Formato dos dados de Resposta

Codigo:

Código interno atribuído pela aplicação bigint

Descricao:

Descricao do local string

Posto:

Indica se é posto/estação bool

Exemplos

`GET Combustiveis`

Este método permite obter todos os tipos de combustíveis existentes.

Argumentos

Sem argumentos:

Este método não necessita de argumentos.

Formato dos dados de Resposta

Codigo:

Códigostring

Descricao:

Descrição string

Exemplos

`GET Classes`

Este método permite obter todos as classes existentes.

Argumentos

Sem argumentos:

Este método não necessita de argumentos.

Formato dos dados de Resposta

Codigo:

Códigostring

Descricao:

Descrição string

Exemplos

`GET Categorias`

Este método permite obter todas as categorias existentes.

Argumentos

Sem argumentos:

Este método não necessita de argumentos.

Formato dos dados de Resposta

Codigo:

Códigostring

Descricao:

Descrição string

Exemplos

`GET Frotas`

Este método permite obter todos as frotas existentes.

Argumentos

Sem argumentos:

Este método não necessita de argumentos.

Formato dos dados de Resposta

Codigo:

Códigostring

Descricao:

Descrição string