Integre suas aplicações externas com o poder do OS Garagem. Nossa API RESTful permite gerenciar ordens, clientes e serviços de forma programática.
https://api.osgaragem.com/v1/
A API utiliza autenticação baseada em sessão para endpoints protegidos e chaves de API para identificação do sistema consumidor.
Para começar, você deve realizar o login para obter uma sessão válida.
Autentica um usuário e inicia uma sessão de API.
{
"email": "admin@oficina.com",
"password": "senha_secreta"
}
{
"status": "success",
"data": {
"user": {
"id": 1,
"nome": "Administrador",
"email": "admin@oficina.com",
"cargo": "admin"
},
"session_id": "a1b2c3d4..."
}
}
Retorna a lista de clientes cadastrados na conta vinculada.
{
"status": "success",
"data": [
{
"id": 101,
"nome": "João da Silva",
"telefone": "(11) 99999-9999",
"email": "joao@email.com",
"veiculos_count": 2
},
{
"id": 102,
"nome": "Maria Oliveira",
"telefone": "(11) 88888-8888",
"veiculos_count": 1
}
]
}
Consulta as ordens de serviço ativas e históricas.
| Parâmetro | Tipo | Descrição |
|---|---|---|
status |
String | Filtrar por status (ex: aberta, concluida). |
cliente_id |
Int | Filtrar por ID do cliente. |
{
"status": "success",
"data": [
{
"id": 5001,
"cliente": "João da Silva",
"veiculo": "Fiat Uno 2010",
"status": "aberta",
"valor_total": 150.00,
"created_at": "2023-10-25 14:30:00"
}
]
}