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 Relatório de Mapa de Cotações
Está disponível através de API a emissão do relatório “Mapa de Cotações”, permitindo que as negociações de cotações sejam analisadas através do relatório mesmo sem acesso direto ao Sienge.
A consulta traz como resultado uma “URL” que, ao acessar, faz o Download do relatório referente aos filtros aplicados na consulta.
Para encontrar esse recurso basta acessar o endpoint: /purchase-quotations/comparison-map/pdf. Disponível em nossa página de APIs: https://api.sienge.com.br/docs/#/purchase-quotations-v1
A API Relatório de Mapa de Cotações traz a seguinte informação: - urlReport
O urlReport pode ser utilizado para download do relatório em até 30 minutos após a requisição. Expirado esse prazo, o link gerado deixa de funcionar e será necessário gerar uma nova requisição para obter o relatório.
Com os seguintes filtros:
- Código da Cotação (purchaseQuotationId)
- Código do Fornecedor (supplierId)
- Código do Comprador (buyerID)
- Código da Obra (buildingId)
- Data de Início do relatório (startDate)
- Data de Fim do relatório (endDate)
Caso seja informado o parâmetro “purchaseQuotationId”, não deve ser enviado os campos “buyerId”, “startDate” e “endDate”. Porém, caso não seja informado o “purchaseQuotationId”, então o “stardDate” e “endDate” se tornam obrigatórios.
Além dos filtros referente as cotações, há também 10 filtros que representam cada uma das flags disponíveis na emissão do relatório:
Agora você tem em mãos uma maneira mais prática de emitir o relatório, facilitando seu dia a dia na análise de Cotações e garantir as melhores tomadas de decisões.
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!