Introdução Autenticação Gerar Token de autorização Conta Informação da conta Criar da conta Anúncios Adicionar anúncio Atualizar anúncio Ler anúncio Ler todos os anúncios Ativar anúncio Apagar anúncio Marcas Ler todas as marcas Ler modelos por marca Ler sub-modelos por modelo Imagens Adicionar imagens Apagar imagens Localização Ler todos os distritos Ler cidades por distrito Stands Ler stand Ler todos os stands Criar stand
API HelloCar
Introdução

Todos os recursos aqui descritos seguem as diretrizes REST e precisam de autorização prévia por meio da estrutura OAuth2. As solicitações não autorizadas, bem como todas as outras solicitações mal compreendidas, retornam códigos de erro HTTP correspondentes, seguidos por descrições de erro legíveis por humanos.

Todas as chamadas de API aqui documentadas são relativas ao domínio base:
Ambiente URL Base
Produção https://api.hellocar.pt/
Autenticação
Autenticação - Gerar token de autenticação
Todos os recursos expostos pela API são restritos e a autenticação do usuário (e subsequente autorização com token) é necessária para o acesso. Os dados para autenticação deverão ser solicitados ao anunciante e este deverá a partir da sua conta de utilizador gerar a password exclusiva à API.
POST
/token
Parâmetros
Parâmetro Tipo Descrição
grant_type String Tipo de concessão permitido: "password"
username String Login do utilizador (email)
password String Password do utilizador dedicada à API
curl -X POST
-d "grant_type=password"
-d "username=client_id"
-d "password=client_secret_key"
https://api.hellocar.pt/token
Parâmetros (resposta c/ sucesso / erro)
Parâmetro Tipo Descrição
access_token String Token de autorização a ser usado em solicitações subsequentes
token_type String Apenas "bearer"
expires_in Number Código secreto de utilizador
error String Pedido com erro
error_description String Descrição do erro
HTTP/1.1 200 OK
{
"access_token": "yWzzosms1mZiES_tZiJG8CndIxktCUzvypcoYhJ3zDrpXi",
"token_type": "bearer",
"expires_in": 43200
}
HTTP/1.1 400 Bad request
{
"error": "Acesso inválido",
"error_description": "As credenciais do usuário não conferem."
}
Conta
Conta - Estado da conta de cliente
Esta seção permite verificar o estado da conta autenticada, indicando o respetivo 'id'.
GET
/api/getstatusaccount
Permission: read
HTTP/1.1 GET /api/getstatusaccount

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso / erro)
Parâmetro Tipo Descrição
state String Estado do pedido
current_package String Pack atual do utilizador
balance Number Saldo da conta do utilizador
HTTP/1.1 200 OK
{
"state": "Success"
"current_package": "Plus"
"balance": "75.0"
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
}
Conta - Criar conta
Esta seção permite criar uma nova conta "Profissional" e apenas está acessível a parceiros da Hellocar.
POST
/api/AddAccount
Parâmetros
Parâmetro Tipo Descrição
keypartner String Chave de parceiro: fornecida pela Hellocar.
email String Email da entidade.
password String Password da entidade: Entre 7 a 16 caracteres.
apipassword String Password de acesso à API: Entre 15 a 20 caracteres.
subscribe Number Subscrição à newsletter: falso '0' / verdadeiro '1'
companyname String Nome da entidade.
socialdenomination String Denominação social da entidade.
fristname String Primeiro nome do responsável.
lastname String Último nome do responsável.
address String Morada da entidade.
cp String Código postal da entidade.
district String Distrito da entidade.
county String Concelho da entidade.
taxid String Nif da entidade.
phone String Telefone da entidade.
namestand String Nome do stand
addressstand String Morada do stand.
cpstand String Código postal do stand.
districtstand String Distrito do stand.
countystand String Concelho do stand.
latstand String Latitude do stand.
lngstand String Longitude do stand.
emailstand String Email do stand.
POST /api/AddAccount HTTP/1.1

Content-Type: application/json
Authorization: None / Parâmetro: keypartner (chave de parceiro fornecida pela Hellocar)

{
"keypartner":"fEfdlc153vQtt4w",
"email": "email@email.com",
"password": "password",
"apipassword": "passwordapi",
"subscribe": 1,
"companyname": "Nome da empresa",
"socialdenomination": "Denominação social",
"fristname": "Paulo",
"lastname": "Sousa",
"address": "Rua da entidade",
"cp": "4444-44",
"district": "1",
"county": "24",
"taxid": "232443433",
"phone": "936767754",
"namestand": "Stand X",
"addressstand": "Rua do stand",
"cpstand": "4444-44",
"districtstand": "1",
"countystand": "24",
"latstand": "41.19849670161758",
"lngstand": "-8.60786279358363",
"emailstand": "email@email.com"
}
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id da conta criada
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Conta criada com sucesso (id:7103).",
"id": 7103
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro"
"id": 0
}
Anúncios
Anúncio - Adiciona anúncio
Esta seção permite adicionar um anúncio na conta a que está autenticado. Os parametros necessários dependem do tipo de anúncio a inserir.
POST
/api/AddAd
Parâmetros
Parâmetro Tipo Descrição
type_advert String Tipo de anúncio: 'Carros', 'Peças', 'Motas', 'Comerciais', 'Pesados', 'Autocaravanas',
visible Number Anúncio visível '1' ou escondido '0'
phone String Inserir telefone unicamente para este anúncio, ou não inserir este parâmetro para ser utilizado o telefone geral. (opcional)
email String Inserir email unicamente para este anúncio, ou não inserir este parâmetro para ser utilizado o email geral. (opcional)
address String Inserir morada unicamente para este anúncio, ou não inserir este parâmetro para ser utilizado a morada geral. (opcional)
cp String Código postal do stand. (opcional)
county Number Id da cidade do stand. (opcional)
district Number Id do distrito do stand. (opcional)
lat String Latitude do stand. (opcional)
lng String Longitude do stand. (opcional)
make String Marca do veículo ou categoria da peça
model String Modelo do veículo ou sub-categoria da peça. (opcional)
submodel String Submodelo do veículo. (opcional, apenas para veículos com submodelos, ex: Mercedes e BMW)
version String Versão do veículo ou nome da peça. (opcional)
year_regist Number Ano de registo do veículo
month_regist String Mês de registo do veículo. (opcional)
fuel_type String Combustível do veículo: 'Gasolina', 'Diesel', 'GPL', 'GNC', 'Elétrico', 'Híbrido (Gasolina)', 'Híbrido (Gasóleo)', 'Híbrido (Plug-In)', 'Hidrogénio'
power_cv Number Potência do veículo
engine_displacement Number Cilindrada do veículo
doors Number Número de portas do veículo
box_type String Tipo de caixa do veículo: 'Manual', 'Automática', 'Semi-automática'
mileage Number Número de quilómetros do veículo
registration String Matrícula do veículo: ex. 11-AA-10 (opcional)
body_type String Segmento do veículo:
Carros ('Pequeno citadino', 'Citadino', 'Utilitário', 'Sedan', 'Carrinha', 'Monovolume', 'SUV / TT', 'Cabrio', 'Coupé', 'Pick Up');
Motas ('Chooper / Cruiser', 'Enduro / Todo terreno', 'Grand Turismo', 'Motociclos nacionais', 'Motos 125', 'Naked', 'Quadriciclos', 'Scooter acima de 125', 'Scooter até 125', 'Sport / Turismo', 'Supersport', 'Trail', 'Tricíclo', 'Utilitária')
Comerciais ('Furgões', 'Comerciais até 3,5 t', 'Comerciais ligeiros')
Pesados ('Transportes', 'Construção', 'Agricultura')
Autocaravanas ('Furgão', 'Perfiladas', 'Integral', 'Capucine', 'Caravana Pickup', 'Caravana', 'Atrelado tenda')
color String Cor do veículo: 'Amarelo', 'Azul', 'Bege', 'Branco', 'Cinzento', 'Dourado', 'Laranja', 'Prateado', 'Preto', 'Roxo', 'Verde', 'Vermelho', 'Castanho', 'Outra'
color_metallic Number Pintura metalizada do veículo
price Number Preço do veículo ou da peça. (opcional)
price_fixed Number Preço fixo do anúncio. (opcional)
accepts_resumption Number Aceita retoma. (opcional)
discriminated_vat Number IVA descriminado. (opcional)
deductible_vat Number IVA dedutível. (opcional)
financing Number Fornece financimento. (opcional)
without_isv Number Valor sem ISV. (opcional)
accept_exchange Number Aceita troca. (opcional)
imported Number Veículo importado (opcional): 1 = Nacional | 2 = Importado
accident Number Veículo sinistrado (opcional): 1 = Sinistrado | 0 = Sem sinistros
capacity Number Capacidade do veículo. (opcional)
vehicle_class String Classe do veículo (carros): 'Class 1', 'Class 2', 'Class 3', 'Class 4'. (opcional)
traction String Tipo de tração do veículo: 'Integral', 'Tração dianteira', 'Tração traseira'. (opcional)
maximum_autonomy_km Number Autonomia máxima do veículo. (opcional)
co2_emissions_g_km Number Número (g/km) de emissões C02 do veículo. (opcional)
urban_consumption_l_100km Number Consumo (l/100km) urbano do veúclo. (opcional)
extra_urbanConsumption_l_100km Number Consumo (l/100km) extra urbano do veúclo. (opcional)
combined_consumption_l_100km Number Consumo (l/100km) combinado do veúclo. (opcional)
urban_consumption_kwh_100km Number Consumo (kwh/100km) urbano do veúclo. (opcional)
extra_urban_consumption_kwh_100km Number Consumo (kwh/100km) extra urbano do veúclo. (opcional)
combined_consumption_kwh_100km Number Consumo (kwh/100km) combinado do veúclo. (opcional)
saved Number Veículo salvado. (opcional): 1 = Sim, salvado | 0 = Não
non_smoking Number Não fumadores. (opcional)
two_key Number 2º chave disponível. (opcional)
classic Number Veículo clássico. (opcional)
iuc Number IUC do veículo. (opcional)
particles_filter Number Tem filtro de particulas. (opcional)
vin String Número VIN do veículo. (opcional)
warranty_fabric_date String Data de garantia de fábrica. (opcional)
warranty_stand_date Number Data de garantia do stand. (opcional)
video String URL do Youtube. (opcional)
annotations String Outras anotações para o anúncio. (opcional)
number_changes_box Number Número de mudanças do veículo. (opcional)
inspection_validity_date String Data de inspeção válida. (opcional)
number_registers Number Número de registos do veículo. (opcional)
revision_book_complete Number Livro de revisões completo. (opcional)
images Object Url´s das imagens do anúncio. Transfere no máximo 30 imagens, as restantes serão ignoradas. (opcional)
stand_id Number Id do stand. Caso este parâmetro não seja inserido, por defeito é atribuído '0'. O valor '0' significa que é para utilizar os contactos principais da conta. (opcional)
reference String Rferência do artigo. (utilizado apenas para peças; opcional)
manufacturer String Nome do fabricante do artigo. (utilizado apenas para peças; opcional)
vehicle_type Number Peça para que tipo de veículo (utilizado apenas para peças; opcional): 1 = Carros | 3 = Comerciais | 4 = Motos | 5 = Autocaravanas | 6 = Pesados
delivery Number Faz entrega? (utilizado apenas para peças; opcional): 1 = Sim | 2 = Não
new_part Number Peça nova? (utilizado apenas para peças; opcional): 1 = Sim | 0 = Não
carsParts Number É um carro para peças? (utilizado apenas para peças; opcional): 1 = Sim | 0 = Não
POST /api/AddAd HTTP/1.1

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
"type_advert": "Carros",
"visible": 1,
"phone": "939293823",
"email": "email@email.com",
"address": "Rua do stant",
"cp": "4444-444",
"county": "208",
"district": "10",
"lat": "41.19849670161758",
"lng": "-8.60786279358363",
"make": "BMW",
"model": "Série 1",
"submodel": "114",
"version":"D Pack M Look M1",
"year_regist": 2010,
"month_regist": "Fevereiro",
"fuel_type": "Diesel",
"power_cv": 150,
"engine_displacement": 2000,
"doors": 5,
"box_type": "Automática",
"mileage": 199000,
"registration": "10-AA-10",
"body_type": "SUV / TT",
"color": "Branco",
"color_metallic":1,
"price": 20000,
"price_fixed": 1,
"accepts_resumption": 1,
"discriminated_vat": 1,
"deductible_vat": 1,
"financing": 1,
"without_isv":1,
"accept_exchange":1,
"imported":1,
"accident":1,
"capacity":1,
"vehicle_class":"Class 2",
"traction":"Tração dianteira",
"maximum_autonomy_km":300,
"co2_emissions_g_km":154,
"urban_consumption_l_100km":10,
"extra_urbanConsumption_l_100km":11,
"combined_consumption_l_100km":12,
"urban_consumption_kwh_100km":10,
"extra_urban_consumption_kwh_100km":11,
"combined_consumption_kwh_100km":12,
"saved":1,
"non_smoking":1,
"two_key":1,
"classic":1,
"iuc":100,
"particles_filter":1,
"vin":"e1e13e31e1",
"warranty_fabric_date":"02/06/2021",
"warranty_fabric_km":1000,
"warranty_stand_date":12,
"video":"www.url.com",
"annotations":"Descrição do anúncio.",
"number_changes_box":5,
"inspection_validity_date":"02/06/2021",
"number_registers":1,
"revision_book_complete":1,
"images":
["https://url.com/img.jpg", "https://url.com/img.jpg"],
"stand_id":5
}
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id do anúncio eliminado
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Anúncio criado com sucesso (id:7103).",
"id": 7103
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro"
}


Anúncio - Atualiza anúncio
Esta seção permite atualizar um anúncio existente na conta a que está autenticado. Os parametros necessários dependem do tipo de anúncio a inserir.
PUT
/api/UpdateAd/:id
Parâmetros
Parâmetro Tipo Descrição
id Number Id do anúncio a atualizar
Parâmetros
Parâmetro Tipo Descrição
visible Number Anúncio visível '1' ou escondido '0'
phone String Inserir telefone unicamente para este anúncio. Caso não insira este parâmetro será utilizado o telefone geral. (opcional)
email String Inserir email unicamente para este anúncio. Caso não insira este parâmetro será utilizado o email geral. (opcional)
address String Inserir morada unicamente para este anúncio. Caso não insira este parâmetro será utilizado a morada geral. (opcional)
cp String Código postal do stand. (opcional)
county Number Id da cidade do stand. (opcional)
district Number Id do distrito do stand. (opcional)
lat String Latitude do stand. (opcional)
lng String Longitude do stand. (opcional)
version String Versão do veículo. (opcional)
year_regist Number Ano de registo do veículo
month_regist String Mês de registo do veículo. (opcional)
fuel_type String Combustível do veículo: 'Gasolina', 'Diesel', 'GPL', 'GNC', 'Elétrico', 'Híbrido (Gasolina)', 'Híbrido (Gasóleo), 'Híbrido (Plug-In)', 'Hidrogénio''
power_cv Number Potência do veículo
engine_displacement Number Cilindrada do veículo
doors Number Número de portas do veículo
box_type String Tipo de caixa do veículo: 'Manual', 'Automática', 'Semi-automática'
mileage Number Número de quilómetros do veículo
registration String Matrícula do veículo: ex. 11-AA-10 (opcional)
body_type String Segmento do veículo:
Carros ('Pequeno citadino', 'Citadino', 'Utilitário', 'Sedan', 'Carrinha', 'Monovolume', 'SUV / TT', 'Cabrio', 'Coupé', 'Pick Up');
Motas ('Chooper / Cruiser', 'Enduro / Todo terreno', 'Grand Turismo', 'Motociclos nacionais', 'Motos 125', 'Naked', 'Quadriciclos', 'Scooter acima de 125', 'Scooter até 125', 'Sport / Turismo', 'Supersport', 'Trail', 'Tricíclo', 'Utilitária')
Comerciais ('Furgões', 'Comerciais até 3,5 t', 'Comerciais ligeiros')
Pesados ('Transportes', 'Construção', 'Agricultura')
Autocaravanas ('Furgão', 'Perfiladas', 'Integral', 'Capucine', 'Caravana Pickup', 'Caravana', 'Atrelado tenda')
color String Cor do veículo: 'Amarelo', 'Azul', 'Bege', 'Branco', 'Cinzento', 'Dourado', 'Laranja', 'Prateado', 'Preto', 'Roxo', 'Verde', 'Vermelho', 'Castanho', 'Outra'
color_metallic Number Pintura metalizada do veículo. (opcional)
price Number Preço do veículo ou da peça. (opcional)
price_fixed Number Preço fixo do anúncio. (opcional)
accepts_resumption Number Aceita retoma. (opcional)
discriminated_vat Number IVA descriminado. (opcional)
deductible_vat Number IVA dedutível. (opcional)
financing Number Fornece financimento. (opcional)
without_isv Number Valor sem ISV. (opcional)
accept_exchange Number Aceita troca. (opcional)
imported Number Veículo importado (opcional): 1 = Nacional | 2 = Importado
accident Number Veículo sinistrado (opcional): 1 = Sinistrado | 0 = Sem sinistros
capacity Number Capacidade do veículo. (opcional)
vehicle_class String Classe do veículo (carros): 'Class 1', 'Class 2', 'Class 3', 'Class 4'. (opcional)
traction String Tipo de tração do veículo: 'Integral', 'Tração dianteira', 'Tração traseira'. (opcional)
maximum_autonomy_km Number Autonomia máxima do veículo. (opcional)
co2_emissions_g_km Number Número (g/km) de emissões C02 do veículo. (opcional)
urban_consumption_l_100km Number Consumo (l/100km) urbano do veúclo. (opcional)
extra_urbanConsumption_l_100km Number Consumo (l/100km) extra urbano do veúclo. (opcional)
combined_consumption_l_100km Number Consumo (l/100km) combinado do veúclo. (opcional)
urban_consumption_kwh_100km Number Consumo (kwh/100km) urbano do veúclo. (opcional)
extra_urban_consumption_kwh_100km Number Consumo (kwh/100km) extra urbano do veúclo. (opcional)
combined_consumption_kwh_100km Number Consumo (kwh/100km) combinado do veúclo. (opcional)
saved Number Veículo salvado. (opcional): 1 = Sim, salvado | 0 = Não
non_smoking Number Não fumadores. (opcional)
two_key Number 2º chave disponível. (opcional)
classic Number Veículo clássico. (opcional)
iuc Number IUC do veículo. (opcional)
particles_filter Number Tem filtro de particulas. (opcional)
vin String Número VIN do veículo. (opcional)
warranty_fabric_date String Data de garantia de fábrica. (opcional)
warranty_stand_date Number Data de garantia do stand. (opcional)
video String URL do Youtube. (opcional)
annotations String Outras anotações para o anúncio. (opcional)
number_changes_box Number Número de mudanças do veículo. (opcional)
inspection_validity_date String Data de inspeção válida. (opcional)
number_registers Number Número de registos do veículo. (opcional)
revision_book_complete Number Livro de revisões completo. (opcional)
stand_id Number Id do stand. Caso este parâmetro não seja inserido, por defeito é atribuído '0'. O valor '0' significa que é para utilizar os contactos principais da conta. (opcional)
PUT /api/UpdateAd/999 HTTP/1.1

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
"visible": 1,
"phone": "939293823",
"email": "email@email.com",
"address": "Rua do stant",
"cp": "4444-444",
"county": "208",
"district": "10",
"lat": "41.19849670161758",
"lng": "-8.60786279358363",
"version":"D Pack M Look M1",
"year_regist": 2010,
"month_regist": "Fevereiro",
"fuel_type": "Diesel",
"power_cv": 150,
"engine_displacement": 2000,
"doors": 5,
"box_type": "Automática",
"mileage": 199000,
"registration": "10-AA-10",
"body_type": "SUV / TT",
"color": "Branco",
"color_metallic":1,
"price": 20000,
"price_fixed": 1,
"accepts_resumption": 1,
"discriminated_vat": 1,
"deductible_vat": 1,
"financing": 1,
"without_isv":1,
"accept_exchange":1,
"imported":1,
"accident":1,
"capacity":1,
"vehicle_class":"Class 2",
"traction":"Tração dianteira",
"maximum_autonomy_km":300,
"co2_emissions_g_km":154,
"urban_consumption_l_100km":10,
"extra_urbanConsumption_l_100km":11,
"combined_consumption_l_100km":12,
"urban_consumption_kwh_100km":10,
"extra_urban_consumption_kwh_100km":11,
"combined_consumption_kwh_100km":12,
"saved":1,
"non_smoking":1,
"two_key":1,
"classic":1,
"iuc":100,
"particles_filter":1,
"vin":"e1e13e31e1",
"warranty_fabric_date":"02/06/2021",
"warranty_fabric_km":1000,
"warranty_stand_date":12,
"video":"www.url.com",
"annotations":"Descrição do anúncio.",
"number_changes_box":5,
"inspection_validity_date":"02/06/2021",
"number_registers":1,
"revision_book_complete":1,
"stand_id":5
}
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id do anúncio eliminado
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Anúncio alterado com sucesso (id:7103).",
"id": 7103
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro"
}


Anúncio - Ler anúncio
Esta seção permite ler um anúncio existente na conta a que está autenticado. Os parametros necessários dependem do tipo de anúncio a inserir.
GET
/api/GetAd/:id
Parâmetros (pedido)
Parâmetro Tipo Descrição
id Number Id do anúncio a ler
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
visible message Mensagem com indicação do estado do pedido
id Number Id do anúncio
url_ad String Url do anúncio
visible Number Anúncio visível '1' ou escondido '0'
phone String Inserir telefone unicamente para este anúncio, ou não inserir este parâmetro para ser utilizado o telefone geral.
email String Inserir email unicamente para este anúncio, ou não inserir este parâmetro para ser utilizado o email geral.
address String Inserir morada unicamente para este anúncio, ou não inserir este parâmetro para ser utilizado a morada geral.
cp String Código postal do stand
county String Id da cidade do stand
district String Id do distrito do stand
lat String Latitude do stand
lng String Longitude do stand
make String Marca do veículo ou categoria da peça
model String Modelo do veículo ou sub-categoria da peça
submodel String Submodelo do veículo
version String Versão do veículo
year_regist Number Ano de registo do veículo
month_regist String Mês de registo do veículo.
fuel_type String Combustível do veículo: 'Gasolina', 'Diesel', 'GPL', 'GNC', 'Elétrico', 'Híbrido (Gasolina)', 'Híbrido (Gasóleo)', 'Híbrido (Plug-In)', 'Hidrogénio'
power_cv Number Potência do veículo
engine_displacement Number Cilindrada do veículo
doors Number Número de portas do veículo
box_type String Tipo de caixa do veículo: 'Manual', 'Automática', 'Semi-automática'
mileage Number Número de quilómetros do veículo
registration String Matrícula do veículo: ex. 11-AA-10
body_type String Segmento do veículo:
Carros ('Pequeno citadino', 'Citadino', 'Utilitário', 'Sedan', 'Carrinha', 'Monovolume', 'SUV / TT', 'Cabrio', 'Coupé', 'Pick Up');
Motas ('Chooper / Cruiser', 'Enduro / Todo terreno', 'Grand Turismo', 'Motociclos nacionais', 'Motos 125', 'Naked', 'Quadriciclos', 'Scooter acima de 125', 'Scooter até 125', 'Sport / Turismo', 'Supersport', 'Trail', 'Tricíclo', 'Utilitária')
Comerciais ('Furgões', 'Comerciais até 3,5 t', 'Comerciais ligeiros')
Pesados ('Transportes', 'Construção', 'Agricultura')
Autocaravanas ('Furgão', 'Perfiladas', 'Integral', 'Capucine', 'Caravana Pickup', 'Caravana', 'Atrelado tenda')
color String Cor do veículo: 'Amarelo', 'Azul', 'Bege', 'Branco', 'Cinzento', 'Dourado', 'Laranja', 'Prateado', 'Preto', 'Roxo', 'Verde', 'Vermelho', 'Castanho', 'Outra'
color_metallic Number Pintura metalizada do veículo
price Number Preço do veículo ou da peça
price_fixed Number Preço fixo do anúncio
accepts_resumption Number Aceita retoma
discriminated_vat Number IVA descriminado
deductible_vat Number IVA dedutível
financing Number Fornece financimento
without_isv Number Valor sem ISV
accept_exchange Number Aceita troca
imported Number Veículo importado
accident Number Veículo sinistrado
capacity Number Capacidade do veículo
vehicle_class String Classe do veículo (carros): 'Class 1', 'Class 2', 'Class 3', 'Class 4'
traction String Tipo de tração do veículo: 'Integral', 'Tração dianteira', 'Tração traseira'
maximum_autonomy_km Number Autonomia máxima do veículo
co2_emissions_g_km Number Número (g/km) de emissões C02 do veículo
urban_consumption_l_100km Number Consumo (l/100km) urbano do veúclo
extra_urbanConsumption_l_100km Number Consumo (l/100km) extra urbano do veúclo
combined_consumption_l_100km Number Consumo (l/100km) combinado do veúclo
urban_consumption_kwh_100km Number Consumo (kwh/100km) urbano do veúclo
extra_urban_consumption_kwh_100km Number Consumo (kwh/100km) extra urbano do veúclo
combined_consumption_kwh_100km Number Consumo (kwh/100km) combinado do veúclo
saved Number Veículo salvado: 1 = Sim, salvado | 0 = Não
non_smoking Number Não fumadores
two_key Number 2º chave disponível
classic Number Veículo clássico
iuc Number IUC do veículo
particles_filter Number Tem filtro de particulas
vin String Número VIN do veículo
warranty_fabric_date String Data de garantia de fábrica
warranty_stand_date Number Data de garantia do stand
video String URL do Youtube
annotations String Outras anotações para o anúncio
number_changes_box Number Número de mudanças do veículo
inspection_validity_date String Data de inspeção válida
number_registers Number Número de registos do veículo
revision_book_complete Number Livro de revisões completo
images Object Url´s das imagens do anúncio
stand_id String Id do stand
GET /api/GetAd/999 HTTP/1.1

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
"state": "Success",
"message": "Leitura do anúncio com sucesso.",
"id": 7103
"url_ad": "https://hellocar.pt/carro/bmw/serie-1/123-d-biturbo-pack-m/000000"
"visible": 1,
"phone": "939293823",
"email": "email@email.com",
"address": "Rua do stant",
"cp": "4444-444",
"county": "208",
"district": "10",
"lat": "41.19849670161758",
"lng": "-8.60786279358363",
"make": "BMW",
"model": "Série 1",
"submodel": "114",
"version":"D Pack M Look M1",
"year_regist": 2010,
"month_regist": "Fevereiro",
"fuel_type": "Diesel",
"power_cv": 150,
"engine_displacement": 2000,
"doors": 5,
"box_type": "Automática",
"mileage": 199000,
"registration": "10-AA-10",
"body_type": "SUV / TT",
"color": "Branco",
"color_metallic":1,
"price": 20000,
"price_fixed": 1,
"accepts_resumption": 1,
"discriminated_vat": 1,
"deductible_vat": 1,
"financing": 1,
"without_isv":1,
"accept_exchange":1,
"imported":1,
"accident":1,
"capacity":1,
"vehicle_class":"Class 2",
"traction":"Tração dianteira",
"maximum_autonomy_km":300,
"co2_emissions_g_km":154,
"urban_consumption_l_100km":10,
"extra_urbanConsumption_l_100km":11,
"combined_consumption_l_100km":12,
"urban_consumption_kwh_100km":10,
"extra_urban_consumption_kwh_100km":11,
"combined_consumption_kwh_100km":12,
"saved":1,
"non_smoking":1,
"two_key":1,
"classic":1,
"iuc":100,
"particles_filter":1,
"vin":"e1e13e31e1",
"warranty_fabric_date":"02/06/2021",
"warranty_fabric_km":1000,
"warranty_stand_date":12,
"video":"www.url.com",
"annotations":"Descrição do anúncio.",
"number_changes_box":5,
"inspection_validity_date":"02/06/2021",
"number_registers":1,
"revision_book_complete":1,
"stand_id":"5"
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro"
}


Anúncios - Ler todos os anúncios
Esta seção permite obter um resumo de todos os anúncios existentes na conta a que está autenticado.
GET
/api/GetAllAds
HTTP/1.1 GET /api/GetAllAds

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado da leitura do anúncio: 'Success', 'Failed' ou 'Conta sem anúncios'
id Number Id do anúncio
status String Estado do anúncio: 'Ativo' ou 'Inativo'
date_expiration String Data em que o anúncio irá expirar
visible Number Se o anúncio está escondido ou visível: '0' ou '1'
last_update String Data da última atualização
date_insert String Data de inserção do anúncio
url_ad String Url do anúncio
HTTP/1.1 200 OK
{
"state": "Success",
"id": 2178,
"status": "Ativo",
"date_expiration": "19/07/2021 16:11:00",
"visible": 0,
"last_update": "20/04/2021 16:10:00",
"date_insert": "20/04/2021 16:10:00",
"url_ad": "https://hellocar.pt/carro/bmw/serie-1/123-d-biturbo-pack-m/000000"
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
}


Anúncios - Ativar anúncio
Esta seção permite ativar um anúncio existente na conta a que está autenticado (no caso da conta ter saldo suficiente).
POST
/api/ActiveAd/:id
Parâmetros (pedido)
Parâmetro Tipo Descrição
id Number Id do anúncio a ativar
HTTP/1.1 POST /api/ActiveAd/999

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id do anúncio eliminado
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Anúncio ativado com sucesso.",
"id": 7104
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro."
}


Anúncio - Apagar anúncio
Esta seção permite apagar um anúncio (existente na conta a que está autenticado.), indicando o respetivo 'id'.
DELETE
/api/DeleteAd/:id
Parâmetros (pedido)
Parâmetro Tipo Descrição
id Number Id do anúncio para apagar
DELETE /api/DeleteAd/999 HTTP/1.1

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id do anúncio eliminado
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Pedido efetuado com sucesso (id:7103).",
"id": 7103
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro."
}
Marcas
Marcas - Ler todas as marcas
Retoma todas as marcas existentes por tipo de anúncio.
GET
/api/GetAllBrands/:typead
Parâmetros (pedido)
Parâmetro Tipo Descrição
typead String Tipo de anúncio: "carros", "peças", "motas", "comerciais", "pesados", "autocaravanas"
HTTP/1.1 GET /api/GetAllBrands/carros

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
brand String Marca do veículo ou categoria da peça
HTTP/1.1 200 OK
{
"brand": "Abarth"
}
HTTP/1.1 400 Bad request
{
"brand": "Failed"
}


Modelos - Ler todos modelos
Retoma todo os modelos existentes de uma determinada marca.
GET
/api/getallmodels/carros/:brand
Parâmetros (pedido)
Parâmetro Tipo Descrição
brand String Marca do veículo ou categoria da peça
HTTP/1.1 GET /api/getallmodels/bmw/

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
model String Modelo do veículo ou sub-categoria da peça
HTTP/1.1 200 OK
{
"model": "X2-M35i"
}
HTTP/1.1 400 Bad request
{
"model": "Failed"
}


Submodelos - Ler todos submodelos
Retoma todo os submodelos existentes de um determinado modelo.
GET
/api/getallsubmodels/:model
Parâmetros (pedido)
Parâmetro Tipo Descrição
model String Modelo do veículo
HTTP/1.1 GET /api/getallsubmodels/série 1/

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
submodel String SubModelo do veículo
HTTP/1.1 200 OK
{
"submodel": "114"
}
HTTP/1.1 400 Bad request
{
"submodel": "Failed"
}
Imagens
Images - Adicionar imagens
Esta seção permite adicionar imagens a um anúncio existente na conta a que está autenticado.
POST
/api/AddImages/:id
Parâmetros (pedido)
Parâmetro Tipo Descrição
id Number Id do anúncio que pretente adicionar imagens
Parâmetro Tipo Descrição
images Object URL da imagem para adicionar
HTTP/1.1 POST /api/AddImages/999

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
"images":
["https://url.com/img.jpg", "https://url.com/img.jpg"]
}
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id do anúncio eliminado
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Imagens adicionadas com sucesso (id:7025).",
"id": 7025
}
HTTP/1.1 400 Bad request
{
"state": "Failed",
"message": "Descrição do erro."
}


Images - Apagar imagens
Esta seção permite apagar todas as imagens de um anúncio existente na conta a que está autenticado.
DELETE
/api/DeleteImages/:id
Parâmetros (pedido)
Parâmetro Tipo Descrição
id Number Id do anúncio que pretente apagar as imagens
HTTP/1.1 DELETE /api/DeleteImages/999

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id do anúncio eliminado
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Imagens eliminadas com sucesso (id:7025).",
"id": 7025
}
HTTP/1.1 400 Bad request
{
"state": "Failed",
"message": "Descrição do erro."
}
Localização
Distritos - Ler todos os distritos
Retoma todos os distritos existentes.
GET
/api/GetDistricts
HTTP/1.1 GET /api/GetDistricts

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
id Number Id do distrito
district String Nome do distrito
HTTP/1.1 200 OK
{
"id": 19,
"district": "Açores"
}
HTTP/1.1 400 Bad request
{
"district": "Failed"
}


Cidades - Ler todas as cidades
Retoma todas as cidades existentes num determinado distrito.
GET
/api/GetCities/:id
Parâmetros (pedido)
Parâmetro Tipo Descrição
id Number Id do distrito
HTTP/1.1 GET /api/GetCities/10

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
id Number Id do distrito
city String Nome da cidade
HTTP/1.1 200 OK
{
"id": 210,
"city": "Amarante"
}
HTTP/1.1 400 Bad request
{
"city": "Failed"
}
Stands
Stand - Ler stand
Esta seção permite ler um stand existente na conta a que está autenticado.
GET
/api/GetStand/:id
Parâmetros (pedido)
Parâmetro Tipo Descrição
id Number Id do stand a ler
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
visible message Mensagem com indicação do estado do pedido
id Number Id do stand
name String Nome do stand
address String Morada do stand
cp String Código postal do stand
county String Id da cidade do stand
district String Id do distrito do stand
lat String Latitude do stand
lng String Longitude do stand
email String Email do stand
phone1 String Telefone 1 do stand
phone2 String Telefone 2 do stand
phone3 String Telefone 3 do stand
GET /api/GetStand/999 HTTP/1.1

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
"state": "Success",
"message": "Leitura do stand com sucesso.",
"id": 5
"name": "Nome do stand",
"address": "Rua do stand",
"cp": "4444-444",
"county": "208",
"district": "10",
"lat": "41.19849670161758",
"lng": "-8.60786279358363",
"email": "email@email.com",
"phone1": "919293929",
"phone2": "919293929",
"phone3": "919293929"
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro"
}


Stand - Ler todos os stand
Esta seção permite ler todos stands existentes na conta a que está autenticado.
GET
/api/GetAllStands
HTTP/1.1 GET /api/GetAllStands

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success', 'Erro causado' ou 'Sem stands'
id Number Id do stand
name String Nome do stand
address String Morada do stand
cp String Código postal do stand
county String Id da cidade do stand
district String Id do distrito do stand
lat String Latitude do stand
lng String Longitude do stand
email String Email do stand
phone1 String Telefone 1 do stand
phone2 String Telefone 2 do stand
phone3 String Telefone 3 do stand
GET /api/GetAllStands/999 HTTP/1.1

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
"state": "Success",
"id": 5
"name": "Nome do stand",
"address": "Rua do stand",
"cp": "4444-444",
"county": "208",
"district": "10",
"lat": "41.19849670161758",
"lng": "-8.60786279358363",
"email": "email@email.com",
"phone1": "919293929",
"phone2": "919293929",
"phone3": "919293929"
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
}


Stand - Adiciona stand
Esta seção permite adicionar um stand na conta a que está autenticado.
POST
/api/AddStand
Parâmetros
Parâmetro Tipo Descrição
name String Nome do stand
address String Morada do stand
cp String Código postal do stand
county int Id da cidade do stand
district int Id do distrito do stand
lat String Latitude do stand
lng String Longitude do stand
email String Email do stand
phone1 String Telefone 1 do stand (opcional)
phone2 String Telefone 2 do stand (opcional)
phone3 String Telefone 3 do stand (opcional)
POST /api/AddStand HTTP/1.1

Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
"name": "Nome do stand",
"address": "Rua do stand",
"cp": "4444-444",
"county": "208",
"district": "10",
"lat": "41.19849670161758",
"lng": "-8.60786279358363",
"email": "email@email.com",
"phone1": "919293929",
"phone2": "919293929",
"phone3": "919293929"
}
Parâmetros (resposta c/ sucesso ou erro)
Parâmetro Tipo Descrição
state String Estado do pedido: 'Success' ou 'Failed'
message String Mensagem com indicação do estado do pedido
id Number Id do stand adicionado
HTTP/1.1 200 OK
{
"state": "Success",
"message": "Stand criado com sucesso (id:7103).",
"id": 5
}
HTTP/1.1 400 Bad request
{
"state": "Failed"
"message": "Descrição do erro"
}