Do token à primeira consulta, sem desvios.
Conecte seu sistema ao Synerasis com OAuth 2.0 e consulte clientes, ordens de serviço, produtos, serviços e dados financeiros com isolamento por empresa.
curl -u "SEU_CLIENT_ID:SEU_CLIENT_SECRET" \
-d "grant_type=client_credentials" \
https://web.synerasis.com.br/api/external/v1/oauth/tokencurl -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
https://web.synerasis.com.br/api/external/v1/clientesAutenticação
OAuth 2.0, escopos por recurso, allowlist de IP opcional e revogação imediata.
Endpoints
Clientes, ordens de serviço, produtos, serviços e financeiro com paginação e filtros.
Erros & limites
Envelope consistente, rate limit por credencial, paginação e regras de período.
Sua primeira chamada em três passos
Configure uma vez, renove o token quando necessário e consulte apenas os recursos autorizados.
Crie uma credencial
No seu Synerasis, um usuário com permissão de API Externa vai em Config → Dados da Empresa → Integrações → API Externa, clica em Nova credencial, escolhe os escopos necessários e confirma a senha atual. O client_id e o client_secret aparecem uma única vez — copie e guarde com segurança.
Troque as credenciais por um token
POST /oauth/token com HTTP Basic (client_id:client_secret) e grant_type=client_credentials. O token retornado (Bearer) vale por 1 hora — não há refresh token, então basta pedir um novo quando expirar.
Chame um endpoint
Envie o token no header Authorization: Bearer <token>. Cada credencial só enxerga os dados da própria empresa e só os campos permitidos pelos escopos que ela tem.
Catálogo de endpoints
A API Externa v1 é somente leitura. Todas as rotas abaixo usam https://web.synerasis.com.br/api/external/v1 e exigem Bearer token, exceto a emissão do token.
No celular, deslize a tabela horizontalmente para ver escopo e regra.
| Método | Rota | Escopo | Regra principal |
|---|---|---|---|
| POST | /oauth/token | — | Client Credentials; token com validade de 1 hora. |
| GET | /clientes | clientes:ler | Listagem paginada; contato exige escopo adicional. |
| GET | /clientes/{id} | clientes:ler | Detalhe opcional com incluir=contato. |
| GET | /ordens-servico | os:ler | data_inicio e data_fim obrigatórios. |
| GET | /ordens-servico/{id} | os:ler | Detalhe com itens e checklist. |
| GET | /produtos | produtos:ler | Produtos ativos por padrão. |
| GET | /servicos | servicos:ler | Serviços ativos por padrão. |
| GET | /contas-receber | contas-receber:ler | Período de vencimento obrigatório. |
| GET | /contas-pagar | contas-pagar:ler | Período de vencimento obrigatório. |
| GET | /boletos | boletos:ler | Período de vencimento obrigatório. |
Sobre o domínio dos exemplos. web.synerasis.com.br é o domínio único e fixo da plataforma — todas as empresas acessam por ele; o que muda entre empresas é o CNPJ/credencial, não o domínio. A API roda no mesmo domínio, em /api/external/v1. Este site (api.synerasis.com.br) é só a documentação.