API de Integração
Endpoints
Cada endpoint é um endereço da API que faz uma coisa só, como listar as empresas ou consultar um pedido. Abra um para ver o que enviar, o que a API devolve e testar com o seu token.
Acesso aos dados do grupo para sistemas externos. Todas as chamadas vão para produção e trabalham com dados reais: não há ambiente de homologação.
Respostas em JSON, campos em camelCase, conteúdo dentro de data. As respostas podem ganhar campos e valores de enum novos: ignore o que não conhecer.
- Endereço da API
- https:/
/ production.bredasapi.com.br/ api - Autenticação
- Authorization: SEU_TOKENsem Bearer; como gerar
- Limite
- 100 requisições por grupo, repõe 5 a cada 3 s erros e limites
- Especificação OpenAPI
- openapi.json para o Postman ou o Insomnia
Autenticação
Troca da chave de integração por um token de acesso. É outro serviço (/overall), por isso não tem o botão Testar: a chave nunca deve ir para o navegador.
Empresa
Empresas do grupo liberadas para a integração. O idEmpresa é usado nos outros recursos.
Pedido
Pedidos em aberto (orçamentos). O id chega no aviso do webhook de orçamento criado.