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 Anexos de Solicitação de Compras
Está disponível através de API GET a possibilidade de consultar e fazer download dos anexos inseridos no cadastro de uma solicitação de compras.
Para consultar os anexos, basta acessar o endpoint: /purchase-requests/{purchaseRequestId}/attachments
Para fazer download de um anexo, basta utilizar o endpoint: /purchase-requests/{purchaseRequestId}/attachments/{attachmentNumber}
Para utilizar o endpoint de consulta dos anexos, é necessário filtrar através do seguinte dado:
- Número da solicitação de compra (purchaseRequestId)
Atenção! É possível consultar os anexos de apenas uma 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 solicitação (purchaseRequestId);
- Número do Anexo (attachmentNumber);
- Nome do arquivo anexado (name);
- Descrição do anexo (description);
Já para utilizar o endpoint para download dos anexos, é necessário especificar dois dados:
- Número da solicitação (purchaseRequestId);
- Número do Anexo (attachmentNumber);
Atenção! Cada requisição poderá especificar apenas um anexo para download, sendo necessário realizar mais de uma requisição caso precise baixar mais de um anexo da solicitação de compras.
Nota! Em caso de sucesso, não será apresentada nenhuma informação do Sienge, apenas será iniciado o download do arquivo requisitado. Caso seja apresentado como resultado o Status de “Recurso não encontrado”, significa que o número da solicitação de compras ou do anexo não foram localizados no Sienge.
Agora é possível consultar e fazer o download dos anexos 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!
Esperamos que este artigo tenha ajudado!