API Developers – OrdemPRO

Índice

→ Autenticação
→ URL Base
→ Ordens de Serviço
→ Clientes
→ Técnicos
→ Webhooks
→ Códigos de Erro

Versão atual: v1.4

Solicitar acesso API

URL Base

Base URL: https://api.ordempro.com.br/v1

Todos os endpoints devem ser chamados usando HTTPS. Requisições HTTP são redirecionadas automaticamente.

Autenticação

O OrdemPRO utiliza Bearer Token (OAuth 2.0). Inclua o token no cabeçalho de todas as requisições:

Authorization: Bearer {seu_token_aqui}
Content-Type:  application/json
Accept:         application/json
          

Tokens expiram em 24 horas. Use o endpoint /auth/refresh para renovar.

Ordens de Serviço

GET/ordens-servico

Lista todas as OS com suporte a filtros e paginação.

GET /v1/ordens-servico?status=em_andamento&page=1&per_page=20

// Resposta
{
  "data": [
    {
      "id": 4821,
      "numero": "OS-2025-4821",
      "status": "em_andamento",
      "cliente_id": 102,
      "tecnico_id": 7,
      "criado_em": "2025-05-01T10:30:00Z"
    }
  ],
  "total": 248,
  "pagina": 1
}
            

POST/ordens-servico

Cria uma nova ordem de serviço.

{
  "cliente_id": 102,
  "tecnico_id": 7,
  "descricao": "Manutenção preventiva ar-condicionado 12000 BTU",
  "prioridade": "alta",
  "prazo": "2025-05-10"
}
            

PUT/ordens-servico/{id}/status

Atualiza o status de uma OS. Valores: aberta | em_andamento | concluida | cancelada.

Webhooks

Configure webhooks para receber notificações em tempo real sobre eventos na plataforma.

// Eventos disponíveis:
"os.criada"         → nova OS criada
"os.atualizada"     → status ou dados alterados
"os.concluida"      → OS finalizada pelo técnico
"os.assinada"       → assinatura digital coletada
"pagamento.recebido" → pagamento registrado
          

Códigos de Erro

Código	Significado
200	Sucesso
201	Recurso criado com sucesso
400	Requisição inválida — verifique os parâmetros
401	Token inválido ou expirado
403	Sem permissão para este recurso
404	Recurso não encontrado
422	Dados com falha de validação
429	Rate limit excedido (100 req/min)
500	Erro interno — abra um chamado