Perguntas frequentes

Não. Todas as chamadas vão para produção e trabalham com os dados reais do grupo. Os recursos da API são consultas e não alteram dados. Veja Ambiente.

Confira se o header Authorization leva só o token, sem o prefixo Bearer. Com Bearer, a chamada é recusada. Se o 401 vier sem corpo, nenhuma empresa da integração tem a API de Integração no contrato, ou o token não é de uma integração. Veja Erros comuns e, se precisar, fale com o suporte.

24 horas. O campo expires_in vem em minutos (1440), não em segundos. Não há refresh token: quando o token expirar, gere outro com a mesma chave. Veja Renovar o token.

As que o administrador escolheu ao criar a integração. Se ele não escolheu nenhuma, a integração acessa todas as empresas do grupo com contrato ativo. Em qualquer caso, a empresa precisa ter a API de Integração no contrato. Para ver a lista, use GET /v1/empresa.

Gere um token novo. O token guarda as empresas liberadas no momento em que foi gerado, inclusive quando a integração foi criada sem empresas escolhidas. O mesmo vale ao contrário: uma empresa removida da integração continua acessível pelos tokens gerados antes, até eles expirarem. Se a empresa não aparecer nem com um token novo, confira com o administrador se ela tem a API de Integração no contrato.

Até 100 de uma vez e, depois, cerca de 100 por minuto (5 a cada 3 segundos), somando todas as integrações do grupo. Quando o limite é atingido, a API responde 429 com o header Retry-After, que diz quantos segundos esperar. Veja Limite de requisições.

Não. Avisos podem chegar repetidos por causa das novas tentativas de entrega. Use evento + id para reconhecer um aviso que você já processou. Veja Boas práticas.

O orçamento foi faturado ou cancelado depois do aviso e saiu da situação de pedido em aberto. A consulta de pedido em aberto só devolve pedidos que ainda não foram faturados nem cancelados.

Gere um token com o exemplo em curl de Gerar o token. Depois, abra o endpoint em Endpoints e clique em Testar: na primeira vez, o teste pede o token. Ele fica só naquela aba, em memória, e vale para todos os endpoints. Você também pode importar a especificação openapi.json no Postman ou no Insomnia. Os testes são chamadas reais em produção e gastam fichas do limite de requisições do grupo.

O CORS da API permite, mas a chave de integração nunca pode ir para o navegador: qualquer pessoa com acesso à página consegue lê-la. Gere o token no seu servidor. Lembre que o token também dá acesso aos dados do grupo enquanto vale, por até 24 horas. No navegador, o seu código não consegue ler o header Retry-After do 429: use os segundos da mensagem do erro.

Ligue para o suporte no (14) 3413-3244. Informe o código de resposta, o horário da chamada e o sessionGuid que veio no erro, quando houver.