Este artigo tem como objetivo orientar quais endpoints precisam ser liberados para utilizar a integração com o Construpoint.
Pré-requisitos
- Ser usuário do tipo Administrador no seu sistema Sienge. Caso não seja, temos este artigo de como tornar seu usuário ADMIN: Como tornar um usuário administrador do sistema?
- Ter um usuário de API criado. Caso ainda não tenha, acesse esse artigo para saber como criar: Como criar usuários de API?
Passo a passo
- Com seu usuário ADMIN logado, acesse a área localizada no canto superior esquerdo da sua tela e selecione o menu Integrações, conforme imagem:
- Na tela seguinte, acesse APIs / Usuários de API:
Após acessar o caminho indicado, o sistema apresentará todos os usuários previamente cadastrados na sua base.
Dentre a listagem, localize o usuário de API que será utilizado na Integração com a Construpoint e clique no ícone de lápis para edição, conforme imagem acima. - Assim que acessar a tela de edição de usuário, será apresentado um menu com campo de busca por palavras chaves. Nessa listagem, é apresentado todos os endpoints que possuímos para autorização.
Vamos autorizar um dos endpoints utilizados pela Construpoint, como exemplo:
IMPORTANTE! Todas as caixinhas devem ser marcadas para autorizar o usuário de API!
Segue abaixo a listagem completa de APIs que devem ser autorizadas para utilização da integração com Construpoint:
Contratos de Suprimentos
GET – /supply-contracts/all
Retorna todos os contratos de suprimentos cadastrados, sem filtros.
GET – /supply-contracts
Retorna contratos de suprimentos aplicando filtros como situação, empresa, fornecedor ou empreendimento.
GET – /supply-contracts/items
Retorna os itens vinculados aos contratos de suprimentos.
GET – /supply-contracts/buildings
Retorna os empreendimentos (obras) relacionados aos contratos de suprimentos.
Medições
GET – /supply-contracts/measurements/all
Retorna todas as medições registradas.
GET – /supply-contracts/measurements/items
Retorna os itens de medição associados ao contrato.
GET – /supply-contracts/measurements/clearing
Retorna informações de glosa/compensação das medições.
POST – /supply-contracts/measurements
Cria uma nova medição para um contrato de suprimentos.
Credores
GET – /creditors
Retorna a lista de credores cadastrados.
Empreendimentos
GET – /enterprises
Retorna os empreendimentos cadastrados.
Empresas
GET – /companies
Retorna todas as empresas cadastradas.
GET – /companies/{companiesID}
Retorna os dados de uma empresa específica.
Não deixe de conferir nossa documentação de API: https://api.sienge.com.br/docs/
Esperamos que este artigo tenha lhe ajudado!