Ampli

Liberações de API

Guia aberto para criar, se necessário, um usuário de API dentro do Sienge e liberar as rotas que a Ampli usa para integrar e sincronizar dados com o seu ERP.

Para quem administra o Sienge

O usuário de API é criado dentro do Sienge. Este site não cria um login na Cartesian: ele apenas orienta como abrir as autorizações no ERP, conferir as 52 rotas e preparar a integração e a sincronização com a Ampli.

Parte 1 · Opcional

Crie um usuário de API no Sienge

Siga esta parte somente se você ainda não tem um usuário de API no Sienge com as credenciais disponíveis. Se já tem, vá direto para a Parte 2.

  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". Este é um usuário de API criado dentro do Sienge para a integração com a Ampli, não um cadastro ou login deste site.

    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, porque 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 do usuário de API no Sienge definido no formulário. Sem esses dados não há como estabelecer a conexão via API.

Parte 2

Abra e entenda a tela de autorizações

  1. 1

    Abra o painel de Autorizações

    Se você acabou de criar o usuário de API no Sienge, a tela "Autorizações do Usuário de API" deve aparecer logo depois de salvar.

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

    Se o usuário de API no Sienge já existia, edite-o

    Se o usuário de API no Sienge já existia, ou se a tela não apareceu, abra a página "Usuários de APIs" e passe o mouse na linha desse usuário para ver o ícone de editar.

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

    Entenda onde buscar e marcar

    Na Parte 3, use o campo "Pesquisar recurso" para achar cada recurso, confira o "Tipo de Recurso" antes de clicar e marque no painel da direita só as rotas indicadas pelo guia.

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

A tela por dentro

Essa mesma tela se repete para cada recurso. Vale entender os quatro pontos abaixo uma vez. Depois é só repetir.

Tela completa "Autorizações do Usuário de API" do Sienge, com o campo de busca e o tipo do recurso à esquerda, o painel de rotas à direita e as caixas de seleção.
  1. 1

    Pesquisar recurso

    O campo de busca no alto. A tela lista centenas de recursos, então em cada item deste guia a gente diz exatamente o que digitar aqui.

  2. 2

    Tipo de Recurso

    A segunda coluna da tabela da esquerda, com "Transacional" ou "Massivo". Vários recursos têm nome parecido ou idêntico e só se diferenciam por esse tipo. Conferir antes de clicar evita liberar o recurso errado.

  3. 3

    Painel da direita

    Ao clicar num recurso, as rotas aparecem à direita, agrupadas por subtítulos como "Planilhas" ou "Bulk-data". Este guia repete os mesmos subtítulos, na mesma ordem.

  4. 4

    As caixinhas

    Cada rota tem uma caixinha à direita. O painel costuma ter muito mais rotas do que a Ampli usa, então marque só as que este guia pede. As que aparecem aqui como "deixar desmarcada" são as que dá pra confundir com as nossas.

Parte 3

Marque e confira as 52 rotas

18 recursos e 52 rotas a marcar. Cada bloco abaixo segue o painel do Sienge: mesmo nome, mesmo tipo, mesmas seções e as rotas na mesma ordem, com a mesma descrição da tela. Somados, esses recursos têm 138 rotas no Sienge, então o painel vai mostrar bem mais linha do que este guia pede. As 10 marcadas como deixar desmarcada são as que dá para confundir com as nossas: aparecem aqui justamente para você não marcar a errada.

0 de 52 conferidas neste guia

Acompanhamentos de obra

Transacional 4 rotas a marcar.
Digite em "Pesquisar recurso" ACOM

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Acompanhamentos de obra" selecionado e as rotas marcadas.

Registro de medição

Calendários de obra

Transacional 2 rotas a marcar, 3 a deixar desmarcada.
Digite em "Pesquisar recurso" CALEND

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Calendários de obra" selecionado e as rotas marcadas.

Calendários

  • PUT /building-projects/{buildingId}/calendar Insere um calendário em uma nova versão da planilha de planejamento de uma obra. O planejamento em questão é identificado pelo respectivo código da obra (buildingId), considerando por padrão a versão atual do planejamento. deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.

Folgas

  • POST /building-projects/{buildingId}/calendar/days-off Insere folgas no calendário da obra em uma nova versão da planilha de planejamento. O planejamento em questão é identificado pelo respectivo código da obra (buildingId), considerando por padrão a versão atual do planejamento. deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.
  • DELETE /building-projects/{buildingId}/calendar/days-off Remove folgas do calendário da obra em uma nova versão da planilha de planejamento. O planejamento em questão é identificado pelo respectivo código da obra (buildingId), considerando por padrão a versão atual do planejamento. deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.

Contratos do suprimentos

Transacional 6 rotas a marcar, 1 a deixar desmarcada.
Digite em "Pesquisar recurso" contratos do s

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Contratos do suprimentos" selecionado e as rotas marcadas.

Contratos

Obras

Itens do contrato

Anexos do contrato

  • POST /supply-contracts/attachments Inclui anexo do contrato deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.

O painel deste recurso tem 15 rotas. As outras não são da Ampli.

Credores

Transacional 3 rotas a marcar, 4 a deixar desmarcada.
Digite em "Pesquisar recurso" cred

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Credores" selecionado e as rotas marcadas.

Creditors

  • PATCH /creditors/{creditorId} Atualiza informações referentes ao credor no Sienge deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.
  • POST /creditors/{creditorId}/bank-informations Inserção das informações bancárias do credor no Sienge deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.
  • PATCH /creditors/{creditorId}/bank-informations Atualiza informações referentes ao credor no Sienge deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.
  • POST /creditors Inserção de credor no Sienge deixar desmarcada É o mesmo caminho de uma rota que você marcou, mas com outro método.

O painel deste recurso tem 18 rotas. As outras não são da Ampli.

Custos unitários

Transacional 5 rotas a marcar.
Digite em "Pesquisar recurso" custos unit

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Custos unitários" selecionado e as rotas marcadas.

Insumos

Composições

Serviços

O painel deste recurso tem 7 rotas. As outras não são da Ampli.

Empreendimentos (Obras)

Transacional 3 rotas a marcar.
Digite em "Pesquisar recurso" EMPREE

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Empreendimentos (Obras)" selecionado e as rotas marcadas.

Agrupamentos de unidades

Enterprises

Estoque de insumos

Transacional 4 rotas a marcar.
Digite em "Pesquisar recurso" estoque

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Estoque de insumos" selecionado e as rotas marcadas.

Itens em estoque

Reservas de estoque

O painel deste recurso tem 9 rotas. As outras não são da Ampli.

Indexadores

Transacional 1 rota a marcar.
Digite em "Pesquisar recurso" inde

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Indexadores" selecionado e as rotas marcadas.

Indexadores

Insumos da obra

Massivo 1 rota a marcar.
Digite em "Pesquisar recurso" INSU

Confira o tipo antes de clicar. Essa busca traz mais de um recurso parecido. Neste bloco o certo é Insumos da obra, com Tipo de Recurso Massivo. Também aparece Insumos orçados da obra (Transacional), que tem bloco próprio neste guia. Insumos do orçamento da obra (Transacional) não entra neste guia: a Ampli não usa nenhuma rota desse recurso, então ele fica sem nada marcado.

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Insumos da obra" selecionado e as rotas marcadas.

Insumos

Insumos orçados da obra

Transacional 1 rota a marcar.
Digite em "Pesquisar recurso" INSU

Confira o tipo antes de clicar. Essa busca traz mais de um recurso parecido. Neste bloco o certo é Insumos orçados da obra, com Tipo de Recurso Transacional. Também aparece Insumos da obra (Massivo), que tem bloco próprio neste guia. Insumos do orçamento da obra (Transacional) não entra neste guia: a Ampli não usa nenhuma rota desse recurso, então ele fica sem nada marcado.

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Insumos orçados da obra" selecionado e as rotas marcadas.

Insumos

Movimentos de caixa e bancos

Massivo 1 rota a marcar, 1 a deixar desmarcada.
Digite em "Pesquisar recurso" movimentos

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Movimentos de caixa e bancos" selecionado e as rotas marcadas.

Bulk-data

  • GET /bank-movement/by-movements Retorna movimentos financeiros, caso possua. deixar desmarcada É o caminho parecido com o da rota que você marcou.

Orçamentos de obra

Massivo 1 rota a marcar.
Digite em "Pesquisar recurso" ORÇAM

Confira o tipo antes de clicar. Essa busca traz mais de um recurso parecido. Neste bloco o certo é Orçamentos de obra, com Tipo de Recurso Massivo. Também aparece Orçamentos de obra (Transacional), que tem bloco próprio neste guia. Orçamento empresarial. (Massivo) não entra neste guia: a Ampli não usa nenhuma rota desse recurso, então ele fica sem nada marcado.

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Orçamentos de obra" selecionado e as rotas marcadas.

Itens de orçamento

Orçamentos de obra

Transacional 2 rotas a marcar.
Digite em "Pesquisar recurso" ORÇA

Confira o tipo antes de clicar. Essa busca traz mais de um recurso parecido. Neste bloco o certo é Orçamentos de obra, com Tipo de Recurso Transacional. Também aparece Orçamentos de obra (Massivo), que tem bloco próprio neste guia. Orçamento empresarial. (Massivo) não entra neste guia: a Ampli não usa nenhuma rota desse recurso, então ele fica sem nada marcado.

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Orçamentos de obra" selecionado e as rotas marcadas.

Itens da planilha

Planilhas

Parcelas do contas a pagar

Massivo 2 rotas a marcar.
Digite em "Pesquisar recurso" PARC

Confira o tipo antes de clicar. Essa busca traz mais de um recurso parecido. Neste bloco o certo é Parcelas do contas a pagar, com Tipo de Recurso Massivo. Também aparece Parcelas do contas a receber (Massivo), que tem bloco próprio neste guia.

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Parcelas do contas a pagar" selecionado e as rotas marcadas.

Bulk data

Bulk-data

Parcelas do contas a receber

Massivo 1 rota a marcar, 1 a deixar desmarcada.
Digite em "Pesquisar recurso" parcelas do contas a r

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Parcelas do contas a receber" selecionado e as rotas marcadas.

Bulk-data

  • GET /income/by-bills Retorna as parcelas dos títulos informados, independente de perído e tipo de período. deixar desmarcada É o caminho parecido com o da rota que você marcou.

Pedidos de compra

Transacional 6 rotas a marcar.
Digite em "Pesquisar recurso" pedidos

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Pedidos de compra" selecionado e as rotas marcadas.
Tela de Autorizações do Sienge com o recurso "Pedidos de compra" selecionado e as rotas marcadas.

Pedidos de compra

O painel deste recurso tem 21 rotas. As outras não são da Ampli.

Planejamentos de obra

Transacional 2 rotas a marcar.
Digite em "Pesquisar recurso" planejamentos

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Planejamentos de obra" selecionado e as rotas marcadas.

Tarefas

Títulos do contas a pagar

Transacional 7 rotas a marcar.
Digite em "Pesquisar recurso" títulos do contas a p

Como deve ficar no Sienge

Tela de Autorizações do Sienge com o recurso "Títulos do contas a pagar" selecionado e as rotas marcadas.

Apropriação obra do título

Títulos

O painel deste recurso tem 42 rotas. As outras não são da Ampli.

Finalize no Sienge

Na tela e na versão do Sienge retratadas neste guia, cada autorização é registrada quando você marca a caixa; não há um botão final Salvar. Depois de conferir as 52 rotas, aguarde as marcações, feche o painel e envie as credenciais pelo canal combinado com a Cartesian.

O checklist local não prova a conclusão no ERP. Se a sua tela funcionar de forma diferente, fale com a Cartesian antes de marcar outra rota.

Alguma rota não aparece na busca, ou a sua tela mostra algo diferente do que está aqui? Fale com a Cartesian que a gente ajusta com você.