O que são APIs?
API (Application Programming Interface ou Interface de Programação de Aplicativos) é uma padronização para comunicação, transferência e/ou carregamento de dados entre dois sistemas, softwares ou aplicativos. Ou seja, API's são Interfaces de Programação de Aplicações, ou um conjunto de endpoints de que formam um recurso, por exemplo: para obter dados, persistir, editar ou excluir um Cliente. O Recurso ou API é esse conjunto destas ações que podem ser realizadas.
A documentação de APIs do Sienge Plataforma é um conteúdo técnico destinado principalmente à desenvolvedores, mas é possível de ser compreendida por usuários não técnicos seguindo os passos deste documento, que visa esclarecer os principais termos técnicos contidos na documentação.
A documentação de APIs é bem dinâmica e pode sofrer atualizações diárias, você pode acessar por este link: https://api.sienge.com.br/docs/
Alguns termos técnicos comuns em integrações que são abordados na nossa documentação são: Como entender a documentação das APIs? : Sienge Plataforma
API Get de Apropriações de Obra de Solicitação de Compras
Está disponível através de API GET a possibilidade de consultar as apropriações de obra definidas nos insumos inseridos no cadastro de uma solicitação de compras.
Para consultar as apropriações, basta acessar o endpoint: /purchase-requests/{purchaseRequestId}/items/{purchaseRequestItemNumber}/buildings-appropriations
Para utilizar o endpoint de consulta das apropriações, é necessário filtrar através do seguinte dado:
- Número da solicitação de compra (purchaseRequestId)
- ID do item da solicitação de compra (purchaseRequestItemNumber)
Atenção! É possível consultar as apropriações de apenas um item da solicitação de compras pra cada requisição feita.
Se a requisição for concluída com sucesso, será apresentado os seguintes dados:
- Número da unidade construtiva (buildingUnitId);
- Referência do item de orçamento apropriado (costEstimationItemReference);
- Percentual apropriado nessa referência (percentage);
Nota! Visto que é possível apropriar um insumo com vários itens de orçamento, é comum que essa requisição traga como resultado um conjunto de várias Unidades Construtivas e Referências, onde o somatório dos seus percentuais vão chegar em 100%, assim como ocorre dentro do Sienge.
- Se a solicitação requisita for referente a uma obra com “Nível de apropriação” igual a “Obra”, então o resultado será apresentado vazio, pois os insumos nesse caso não possuem apropriação de obra.
- Caso seja apresentado como resultado o Status de “Recurso não encontrado”, significa que o número da solicitação de compras ou do item não foram localizados no Sienge.
Agora é possível consultar a apropriação de obra dos insumos inseridos em Solicitações de Compra, sem a necessidade de acessar manualmente o cadastro da solicitação desejada no Sienge.
Quais clientes podem utilizar APIs e Quais recursos do sistema estão disponíveis?
Clientes DC tem disponível os recursos de APIs. Para os clientes com servidor local o acesso de APIs não está disponível.
Para saber mais sobre a disponibilidade e planos acesse Quais clientes podem utilizar APIs e Quais recursos do sistema estão disponíveis? : Sienge Plataforma
Esperamos que este artigo tenha ajudado!