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, APIs são interfaces de Programação de Aplicações, ou um conjunto de endpoints de que formam um recurso como por exemplo: Clientes, Credores, Títulos a Receber. Podemos, por exemplo, obter dados, persistir, editar ou excluir um Cliente. O Recurso ou API é esse conjunto de algumas destas ações que podem ser feitas. 

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. 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 

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/ 

API - Pedidos de Compra

A API GET /purchase-orders permite que os usuários do sistema de compras aprovem ou reprovem pedidos, gerenciem o status desses pedidos de forma eficiente e mantenham um histórico detalhado das autorizações. Além disso, a API possibilita a consulta de pedidos com base em sua conformidade na API pública de Pedidos de Compra, permitindo identificar alterações nos dados de previsão financeira e acessar as cotações que originaram os itens do pedido.

Os usuários também podem visualizar o histórico de autorizações de pedidos, tanto após a aprovação quanto a reprovação, e aplicar filtros para pedidos pendentes, verificando a consistência e o status de aprovação. Ademais, a API fornece informações sobre condições de pagamento, observações e dados de faturamento direto. É possível acessar todas as observações relacionadas a um pedido, incluindo as externas.

Essa API se mostra uma ferramenta essencial para otimizar o gerenciamento de pedidos de compra, oferecendo aos usuários uma visão clara e detalhada do processo de autorização e das informações relevantes. Promovendo maior eficiência, transparência e controle nas operações de compras, contribuindo para decisões mais informadas e ágeis.

API REST – Pedidos de Compra

Foram adicionados 19 endpoints na API REST de Pedidos de Compra. Abaixo, estão detalhados os endpoints com suas respectivas informações. A documentação completa e técnica pode ser acessada em: https://api.sienge.com.br/docs/#/purchase-orders-v1.

• A API REST /purchase-orders/ permite realizar consultas de pedidos de compra.

• A API GET /purchase-orders/{purchaseOrderId} permite consultar o pedido de compra, incluindo o item de cotação que possivelmente deu origem a ele, por meio das informações do ID do item de cotação e do ID da cotação. Assim, é possível consultar as cotações que originaram o pedido de compra.

• A API GET /purchase-orders/{purchaseOrderId}/items permite consultar os itens do pedido de compra, incluindo o item de cotação que possivelmente deu origem a ele, por meio das informações do ID do item de cotação e do ID da cotação. Dessa forma, é possível consultar as cotações que originaram os itens do pedido.

• A API GET /purchase-orders/{purchaseOrderId}/items/{itemNumber} permite consultar um item específico do pedido de compra, utilizando o ID do item de cotação. Assim, possibilita a consulta detalhada do item do pedido de compra. 

• A API GET /purchase-orders/{purchaseOrderId}/items/{itemNumber}/delivery-schedules permite consultar a previsão de entrega do item do pedido de compra, utilizando o ID do item de cotação. Assim, possibilita obter informações sobre a data prevista de entrega do item do pedido de compra.

• A API GET /purchase-orders/{purchaseOrderId}/items/{itemNumber}/buildings-appropriations permite consultar as apropriações de obra do item do pedido de compra, utilizando o ID do item de cotação. Assim, possibilita a consulta das apropriações relacionadas ao item do pedido de compra. 

• A API GET /purchase-orders/{purchaseOrderId}/totalization permite consultar a totalização dos pedidos de compra, que abrange: o total dos insumos, descontos, frete, informações do transportador e condições de pagamento. Portanto, as informações de totalização ficam unificadas e facilmente acessíveis. 

• A API GET /purchase-orders/{purchaseOrderId}/direct-billing permite consultar os dados de faturamento direto do pedido, incluindo as seguintes informações: pedido, fornecedor, obra, valor a vincular, contrato, data do faturamento, responsável e observações. Portando, as informações de faturamento podem ser acessadas facilmente via API.

• API PUT /purchase-orders/{purchaseOrderId}/authorize permite autorizar pedidos de compra que estão pendentes de autorização. Portando, os pedidos com status 'Aguardando Autorização' podem ser autorizados de maneira simples.

• A API PATCH /purchase-orders/{purchaseOrderId}/authorize autoriza pedidos de compra que estão com o status 'Aguardando Autorização', permitindo a inclusão de uma observação. Portando, os pedidos podem ser autorizados, desde que incluam um texto de observação. 
• A API PUT /purchase-orders/{purchaseOrderId}/disapprove reprova pedidos de compra que estão aguardando autorização. Portando, os pedidos com status 'Aguardando Autorização' podem ser reprovados de maneira simples.
• A API PATCH /purchase-orders/{purchaseOrderId}/disapprove reprova pedidos de compra que estão com o status 'Aguardando Autorização', permitindo a inclusão de uma observação. Portando, os pedidos com status 'Aguardando Autorização' podem ser reprovados, acompanhados de um texto de observação.

API – Anexos

• A API POST /purchase-orders/{purchaseOrderId}/attachments permite a inserção de anexos no pedido de compra. Portando, os pedidos de compra podem incluir arquivos anexos com informações adicionais.
• A API GET /purchase-orders/{purchaseOrderId}/attachments permite listar os anexos do pedido de compra. Assim, os pedidos de compra podem exibir os arquivos que estão anexados.
• A API GET /purchase-orders/{purchaseOrderId}/attachments/{attachmentNumber} permite realizar o download dos anexos do pedido de compra. Portando, será possível obter os anexos no formato PDF.

API – Avaliação

• A API GET /purchase-orders/{purchaseOrderId}/supplier-evaluation-criteria permite consultar os critérios de avaliação do fornecedor por meio do código do pedido de compra. Portando, é possível listar os critérios de avaliação disponíveis.
• A API POST /purchase-orders/{purchaseOrderId}/evaluation permite registrar uma avaliação do fornecedor no pedido de compra. Assim, os pedidos de compra poderão incluir uma avaliação referente ao fornecedor.
• A API PUT /purchase-orders/{purchaseOrderId}/evaluation permite registrar uma avaliação do fornecedor no pedido de compra, caso ainda não exista, ou atualizar a última avaliação registrada. Portando, a avaliação do fornecedor estará sempre atualizada.

API – Relatório Análise de Pedido de Compra

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!