Documentação da API

Vehicle Manager

Backend REST para o aplicativo Vehicle Manager. A API permite autenticar usuários e gerenciar veículos e seus registros de manutenção, abastecimento, lembretes e despesas.

PHP · MySQL · JSON · HTTPS

Endereço base

Use este endereço como base e acrescente a rota desejada:

https://appveiculo.cassiagasperoni.com/api/

As respostas são JSON. Envie Content-Type: application/json nas chamadas com corpo.

Autenticação

Envie um Google ID token válido para autenticar ou registrar o usuário. A resposta inclui o user_id. Nas chamadas protegidas, passe o token no cabeçalho Bearer.

curl.exe -i -X POST "https://appveiculo.cassiagasperoni.com/api/auth.php" -H "Content-Type: application/json" -d '{"id_token":"SEU_GOOGLE_ID_TOKEN"}'
curl.exe -i "https://appveiculo.cassiagasperoni.com/api/vehicles.php" -H "Authorization: Bearer SEU_GOOGLE_ID_TOKEN"

A autenticação alternativa por token estático só funciona se tiver sido habilitada pelo administrador. Nunca publique ou compartilhe tokens.

Endpoints disponíveis

Os recursos são sempre limitados ao usuário autenticado. O filtro vehicle_id é opcional nas listagens dos registros do veículo.

AutenticaçãoPOST /api/auth.php
VeículosGET · POST · PUT · DELETE
/api/vehicles.php
ManutençõesGET · POST · PUT · DELETE
/api/maintenances.php
AbastecimentosGET · POST · PUT
/api/fueling.php
LembretesGET · POST · PUT
/api/reminders.php
DespesasGET · POST · PUT
/api/expenses.php

Exemplo de listagem filtrada: GET /api/maintenances.php?vehicle_id=ID_DO_VEICULO.

Formato das operações

GET lista registros; POST cria um registro; PUT atualiza campos e recebe o id no JSON; DELETE remove um registro quando disponível e recebe o id na query string.

curl.exe -i -X POST "https://appveiculo.cassiagasperoni.com/api/vehicles.php" -H "Authorization: Bearer SEU_TOKEN" -H "Content-Type: application/json" -d '{"brand":"Toyota","model":"Corolla","year":2022,"vehicle_type":"car","current_mileage":25000}'

As chamadas inválidas retornam um status HTTP de erro e uma resposta JSON com a mensagem correspondente.

Uso seguro

Use HTTPS em todas as chamadas. Não coloque tokens, senhas ou credenciais do banco nesta página, no aplicativo ou em repositórios públicos. A raiz do domínio é apenas uma página informativa; os dados são acessados pelas rotas protegidas da API.