Integre o seu sistema ao Synerasis com a API Externa

Consulte clientes, ordens de serviço, produtos, serviços e financeiro em integrações servidor a servidor, com OAuth 2.0, escopos por recurso e isolamento por empresa.

Abrir documentação Falar sobre integração
API v1 REST Somente leitura OAuth 2.0
API Externa / v1 REST
Base das requisições https://web.synerasis.com.br/api/external/v1
Primeiro fluxo POST /oauth/token Authorization: Bearer SEU_ACCESS_TOKEN
Client Credentials Token: 1 hora Escopos por recurso

Os dados da sua operação, prontos para consulta

A API Externa conecta o Synerasis às ferramentas que sua equipe já usa para análise, acompanhamento e operação. Consulte os dados autorizados sem retirar o contexto da ordem de serviço ou do cliente.

  • Alimente BI e relatórios Consulte dados operacionais e financeiros para criar visões próprias.
  • Controle o acesso por escopo Cada credencial recebe apenas os recursos necessários para a integração.
  • Mantenha os dados isolados As consultas respeitam a empresa vinculada à credencial utilizada.

Consulte os recursos que sua operação já produz

A versão v1 é somente leitura. Explore cada recurso na documentação oficial, com parâmetros, escopos, respostas e exemplos de requisição.

GET /clientes

Clientes

Consulte clientes e, quando autorizado, os detalhes de contato.

 GET /ordens-servico

Ordens de serviço

Consulte OS, itens e checklist com filtros de período e status.

 GET /produtos

Produtos

Recupere o catálogo de produtos ativos disponível para sua empresa.

 GET /servicos

Serviços

Consulte os serviços ativos cadastrados no Synerasis.

 GET /contas-receber

Financeiro

Consulte contas a receber, contas a pagar e boletos por período.

Da credencial à primeira consulta

O fluxo de integração é curto e documentado para você testar uma chamada antes de construir o restante da solução.

Crie uma credencial

No Synerasis, acesse Config → Dados da Empresa → Integrações → API Externa, escolha os escopos e guarde o segredo exibido.

Solicite um token

Envie POST /oauth/token com Client Credentials e use o Bearer token retornado por até 1 hora.

Consulte um recurso

Envie o token no header Authorization e consulte apenas os recursos liberados para a credencial.

Primeira chamada curl 
# 1. Solicite um token
curl -u "SEU_CLIENT_ID:SEU_CLIENT_SECRET" \
  -d "grant_type=client_credentials" \
  https://web.synerasis.com.br/api/external/v1/oauth/token

# 2. Consulte um recurso
curl -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  https://web.synerasis.com.br/api/external/v1/clientes

Documentação e API são endereços diferentes. api.synerasis.com.br é o portal de documentação. As chamadas da API usam web.synerasis.com.br/api/external/v1.

Antes de começar

Respostas rápidas para validar se a API Externa atende ao seu cenário de integração.

Ver autenticação
A API Externa permite criar ou alterar dados?

A API Externa v1 é somente leitura. Ela permite consultar os recursos autorizados da empresa, sem criar ou alterar registros.

Como funciona a autenticação da API?

A autenticação usa OAuth 2.0 Client Credentials. Você cria uma credencial no Synerasis, solicita um token e o envia como Bearer token nas consultas.

Quais dados posso consultar?

A versão v1 apresenta consultas de clientes, ordens de serviço, produtos, serviços e dados financeiros.

Onde ficam a documentação e a base das requisições?

A documentação fica em api.synerasis.com.br. As requisições usam web.synerasis.com.br/api/external/v1.

Pronto para conectar seus dados?

Comece pela referência oficial ou converse com a equipe Synerasis sobre o cenário da sua integração.

Abrir documentação