Falar com a equipe
Ampli

Liberações de API

Como criar o usuário de API no Sienge e liberar as rotas que a Ampli usa para monitorar a sua obra. É o que precisamos para conectar a Ampli ao seu ERP.

Para quem administra o Sienge

Siga a Parte 1 para criar o usuário de API e a Parte 2 para liberar as 53 rotas. Ao final, envie de volta para a Cartesian o nome de usuário e a senha gerados — sem eles não há como estabelecer a conexão.

Parte 1

Criando o usuário de API

  1. 1

    Abra as Integrações no Sienge

    Dentro do ERP Sienge, no canto superior direito da tela, clique em "Navegue pelo ecossistema" e depois em "Integrações".

    Menu "Navegue pelo ecossistema" do Sienge aberto, com a opção Integrações destacada.
  2. 2

    Acesse "Usuários de APIs"

    Com as Integrações abertas, selecione a opção "Usuários de APIs".

    Lista de integrações do Sienge com a opção "Usuários de APIs" destacada.
  3. 3

    Crie um novo usuário

    No painel de administração de usuários, clique no botão "Novo Usuário de API".

    Painel de administração de usuários de API com o botão "Novo Usuário de API" destacado.
  4. 4

    Preencha o formulário

    Você será levado ao formulário de criação. Preencha os dados do usuário (descrição, e-mail de acesso e nome de acesso) e salve.

    Formulário "Dados de Acesso" do usuário de API do Sienge, com o botão Salvar destacado.
  5. 5

    Copie a senha gerada

    Ao salvar, o Sienge gera uma senha automaticamente. Copie ou anote a senha na hora — ela não é exibida novamente.

    Aviso "Senha gerada com sucesso!" do Sienge, com a senha ocultada e o botão Copiar.

O que anotar e enviar de volta

Usuário
[subdomínio da construtora]-[nome do usuário]
Senha
[gerada automaticamente]

Anote ou copie a senha e encaminhe junto com o nome de usuário definido no formulário. Sem esses dados não há como estabelecer a conexão via API.

Parte 2

Liberando as rotas da API

  1. 1

    Abra o painel de Autorizações

    Assim que o usuário é criado, é necessário liberar as rotas da API. A tela de "Autorizações do Usuário de API" deve aparecer.

    Tela "Autorizações do Usuário de API" do Sienge, com a lista de recursos.
  2. 2

    Não apareceu? Edite o usuário

    Caso não consiga visualizar essa tela, abra novamente a página de "Usuários de APIs" e selecione a opção de editar o usuário.

    Página de usuários de API do Sienge com a opção de editar o usuário.
  3. 3

    Busque cada recurso (rota)

    Com o painel de autorização aberto, use o campo "Pesquisar recurso" para localizar a rota que deseja liberar e marque o checkbox. Repita para cada rota da lista abaixo.

    Painel de autorização do Sienge com o campo "Pesquisar recurso" destacado.
Referência

Rotas a liberar

18 recursos, 53 rotas no total. Busque cada recurso no campo "Pesquisar recurso" e marque as rotas indicadas. Toque no ícone para copiar o caminho.

Orçamentos de obra

Massivo
  • GET /building-cost-estimation-items
Tela de Autorizações do Sienge com o recurso "Orçamentos de obra" e a rota marcada.

Parcelas do contas a pagar

Massivo
  • GET /outcome
  • GET /outcome/by-bills
Tela de Autorizações do Sienge com o recurso "Parcelas do contas a pagar" e a rota marcada.

Títulos do contas a pagar

Transacional
  • GET /bills/{billId}/buildings-cost
  • PUT /bills/{billId}/buildings-cost
  • GET /bills/by-change-date
  • POST /bills
  • GET /bills
  • GET /bills/{billId}
  • PUT /bills/{billId}
Tela de Autorizações do Sienge com o recurso "Títulos do contas a pagar" e a rota marcada.

Movimentos de caixa e bancos

Massivo
  • GET /bank-movement
Tela de Autorizações do Sienge com o recurso "Movimentos de caixa e bancos" e a rota marcada.

Calendários de obra

Transacional
  • GET /building-projects/{buildingId}/calendar/days-off
  • GET /building-projects/{buildingId}/calendar
Tela de Autorizações do Sienge com o recurso "Calendários de obra" e a rota marcada.

Insumos orçados da obra

Transacional
  • GET /building-cost-estimations/{buildingId}/cost-estimate-resources
Tela de Autorizações do Sienge com o recurso "Insumos orçados da obra" e a rota marcada.

Insumos orçados da obra

Massivo
  • GET /building/resources
Tela de Autorizações do Sienge com o recurso "Insumos orçados da obra" e a rota marcada.

Orçamentos de Obra

Transacional
  • GET /building-cost-estimations/{buildingId}/sheets
  • GET /building-cost-estimations/{building_id}/sheets/{building_unit_id}/items
Tela de Autorizações do Sienge com o recurso "Orçamentos de Obra" e a rota marcada.

Planejamentos de obra

Transacional
  • GET /building-projects/{buildingId}/sheets/{buildingUnitId}/tasks
  • PUT /building-projects/{buildingId}/sheets/{buildingUnitId}/tasks
Tela de Autorizações do Sienge com o recurso "Planejamentos de obra" e a rota marcada.

Acompanhamento de obras

  • GET /building-projects/{buildingId}/progress-logs/{measurementNumber}/items/{buildingUnitId}
  • GET /building-projects/progress-logs
  • GET /building-projects/{buildingId}/progress-logs/{measurementNumber}
  • POST /building-projects/{buildingId}/progress-logs/
Tela de Autorizações do Sienge com o recurso "Acompanhamento de obras" e a rota marcada.

Custos Unitários

  • GET /cost-databases/{id}/work-items
  • GET /cost-databases/{id}/work-items-assemblies
  • GET /cost-databases/{id}/resources
  • GET /cost-databases/{cost-database-id}/resources
  • GET /cost-databases/{cost-database-id}/resources/{id}
Tela de Autorizações do Sienge com o recurso "Custos Unitários" e a rota marcada.

Empreendimentos

  • GET /enterprises
  • GET /enterprises/{enterpriseId}
  • GET /enterprises/{enterpriseId}/groupings
Tela de Autorizações do Sienge com o recurso "Empreendimentos" e a rota marcada.

Parcelas do contas a receber

Massivo
  • GET /income
Tela de Autorizações do Sienge com o recurso "Parcelas do contas a receber" e a rota marcada.

Contratos do suprimentos

Transacional
  • GET /contracts/digital-signature-contacts
  • GET /supply-contracts/items
  • GET /supply-contracts/buildings
  • GET /supply-contracts/all
  • GET /supply-contracts
  • GET /supply-contracts/attachments
Tela de Autorizações do Sienge com o recurso "Contratos do suprimentos" e a rota marcada.

Pedidos de compra

Transacional
  • GET /purchase-orders/
  • GET /purchase-orders/direct-billing
  • GET /purchase-orders/items/buildings-appropriation
  • GET /purchase-orders/items/itemNumber
  • GET /purchase-orders/Items
  • GET /purchase-orders/
Tela de Autorizações do Sienge com o recurso "Pedidos de compra" e a rota marcada.
Tela de Autorizações do Sienge com o recurso "Pedidos de compra" e a rota marcada.

Credores

Transacional
  • GET /creditors
  • GET /creditors/bank-informations
  • GET /creditors/{creditorId}
Tela de Autorizações do Sienge com o recurso "Credores" e a rota marcada.

Indexadores

Transacional
  • GET /indexers
Tela de Autorizações do Sienge com o recurso "Indexadores" e a rota marcada.

Estoque de Insumos

Transacional
  • GET /stock-inventories/{costCenterId}/items
  • GET /stock-inventories/{costCenterId}/items/{resourcesId}/building-appropriation
  • GET /stock-reservations
  • GET /stock-reservations/
  • GET /stock-reservations/{reservationId}/items
Tela de Autorizações do Sienge com o recurso "Estoque de Insumos" e a rota marcada.

Alguma rota não aparece na busca ou ficou com dúvida? Fale com a Cartesian que a gente ajusta com você.