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 - Solicitações de compra

Atualmente, todas as solicitações de compra geradas via API são automaticamente registradas como autorizadas no sistema Sienge. Isso não permite que algumas solicitações passem por uma avaliação interna necessária antes da autorização final.

Esta melhoria permiti que as solicitações de compra feitas a partir do canteiro, via API, possam entrar no sistema Sienge como "não autorizados" a partir do cadastro, conforme as autorizações definidas para cada usuário. Isso garantirá que apenas as solicitações devidamente avaliadas e aprovadas internamente sejam processadas como autorizadas. 

 Atenção! 

• Os itens de solicitação criados via API devem ter a capacidade de serem registradas não autorizados a partir do cadastro no Sienge;
* Deve existir um novo motivo de desautorização de item de solicitação correspondente.

A API /purchase-requests/ permite que os usuários do sistema de compras realizem uma consulta de solicitação de compra através de seu ID. Essa solicitação será listada trazendo as informações como: código da obra, departamento, usuário solicitante, status de solicitação do item (Pendente, Parcialmente Atendido, Cancelado), estados de consistência (Em inclusão, Consistente, Inconsistente), data de modificação da solicitação de compra e se o Processo de compra será realizado pela própria obra.

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

API REST – Solicitações de compra

Foram adicionados 13 endpoints na API REST de Solicitações 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-requests-v1.

• Uma API get /(purchase-requests/{purchaseRequestId} permite consultar a solicitação de compra, incluindo o item de solicitação que possivelmente deu origem a ele, por meio das informações do ID da solicitação. Assim, é possível consultar os insumos (itens) da solicitação específica.
• API PATCH /purchase-requests/{purchaseRequestId}/authorize autoriza todos os itens de uma solicitação que estão aguardando autorização.
• API PATCH /purchase-requests/{purchaseRequestId}/disapproval reprova todos os itens de uma solicitação que estão aguardando autorização.
• API POST /purchase-requests cria uma solicitação de compra para uma obra já existente.

API – Item de Solicitação de Compra

• API GET /purchase-requests/all/items permite consultar todos os itens da solicitação de compra.
•  API GET /purchase requests/{purchaseRequestId}/items/{purchaseRequestItemNumber}/buildings-appropriations permite consultar as apropriações de um item da solicitação de compra existente.
• API GET/purchase-requests/{purchaseRequestId}/items/{purchaseRequestItemNumber}/delivery-requirements permite consultar as entregas de um item da solicitação de compra existente.
• API POST /purchase-requests/{purchaseRequestId}/items cria itens para uma solicitação de compra já existente.
• API PATCH  /purchase-requests/{purchaseRequestId}/items/{purchaseRequestItemNumber}/authorize autoriza um item de uma solicitação que está aguardando autorização.
• API PATCH /purchase-requests/{purchaseRequestId}/items/{purchaseRequestItemNumber}/disapproval reprova um item de uma solicitação que está aguardando autorização.
• Novo Endpoint:Permite a inserção de um ou mais insumos em uma solicitação de compra. Dessa forma, é possível inserir qual o insumo, a quantidade e a unidade de medida para a solicitação.

Atenção! Essas solicitações de compras, geradas automaticamente via API, serão marcadas como desautorizadas no sistema Sienge, o que obriga que elas passem pela avaliação interna

necessária antes da autorização final. Portanto, as solicitações de compra são facilitadas pela utilização da API. Não sendo mais necessário, obrigatoriamente, acessar o Sienge para realizar solicitações de compra.

API – Anexos

• API GET /purchase-requests/{purchaseRequestId}/attachments/ permite consultar os anexos da solicitação de compra
  
• API GET /purchase-requests/{purchaseRequestId}/attachments/{attachmentNumber} permite realizar o download dos anexos da solicitação de compra. Portando, será possível obter os anexos no formato PDF.

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!