Acesso programático a veículos, despesas, lembretes, membros da frota e atividade. Base URL: https://api.aufix.app.
Visão geral
- All REST routes are under
/v1/…. - Successful responses use
{ "data": … }. - Errors use
{ "error": { "code": "…", "message": "…" } }. - Operational routes require an active Fleet plan (Fleet, Fleet Pro, or Fleet Max).
- Personal access tokens (PAT) are rate-limited; responses may include
Retry-After.
Autenticação
| HTTP | Recurso | Descrição |
|---|
| — | Authorization: Bearer … | Todas as rotas abaixo exigem um token de acesso pessoal: Authorization: Bearer aufix_pat_…. Crie e revogue chaves em Configurações → Integrações (o segredo é exibido apenas uma vez). read — somente GET; write — todos os métodos. |
Veículos
| HTTP | Recurso | Descrição |
|---|
| GET | /v1/vehicles | Lista os veículos acessíveis. Query: limit, cursor after. |
| POST | /v1/vehicles | Cria um veículo na sua garagem. |
| GET | /v1/vehicles/:vehicleId | Obtém um veículo. |
| PATCH | /v1/vehicles/:vehicleId | Atualiza os campos de um veículo. |
| DELETE | /v1/vehicles/:vehicleId | Exclui um veículo e os registros relacionados (proprietário). |
Atualizações do veículo
| HTTP | Recurso | Descrição |
|---|
| GET | /v1/vehicles/:vehicleId/updates | Lista as atualizações de status (quilometragem, combustível/carga, condição, pneus, comentário). Query: limit, afterId + afterAt. |
| POST | /v1/vehicles/:vehicleId/updates | Registra uma nova atualização de um veículo. |
Despesas
| HTTP | Recurso | Descrição |
|---|
| GET | /v1/expenses | Lista as despesas (das mais recentes para as mais antigas). Query: limit, vehicleId, cursor afterId + afterValue. |
| POST | /v1/expenses | Cria uma despesa para um veículo ou uma despesa pessoal sem veículo. |
| PATCH | /v1/expenses/:expenseId | Atualiza uma despesa. |
| DELETE | /v1/expenses/:expenseId | Exclui uma despesa. |
Lembretes
| HTTP | Recurso | Descrição |
|---|
| GET | /v1/reminders | Lista os lembretes por data de vencimento. Query: limit, vehicleId, cursor afterId + afterValue. |
| POST | /v1/reminders | Cria um lembrete para um veículo ou um lembrete pessoal. |
| PATCH | /v1/reminders/:reminderId | Atualiza os campos de um lembrete (incluindo o estado de concluído, quando houver suporte). |
| DELETE | /v1/reminders/:reminderId | Exclui um lembrete. |
Atividade
| HTTP | Recurso | Descrição |
|---|
| GET | /v1/activity | Histórico de atividades do proprietário da frota. Query: limit, cursor afterId + afterAt. |
Frota
| HTTP | Recurso | Descrição |
|---|
| GET | /v1/fleet/members | Lista os membros da frota, as funções e as atribuições de veículos. |
| GET | /v1/fleet/invites | Lista os convites da frota. Retorna inviteId, email, role, status, acceptedBy, expiresAt, createdAt, updatedAt, isExpired. |