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/  

Novas APIs

• Anexos de contratos 

Esta API permite que integrações possam consultar e enviar os anexos de contratos de vendas do Sienge. Os endpoints consultam as informações do caminho: Comercial > Vendas > Contratos > Emissão > edição do contrato > aba anexos. Foram liberados os endpoints POST que fazem o envio de um arquivo para o contrato, o GET lista que faz a consulta da lista de anexos de um contrato com seu respectivo código e um GET arquivo na qual fará o download do anexo escolhido. A figura abaixo mostra o nome dos endpoints disponíveis na nossa documentação de APIs.  

• Anexos de clientes 

Esta API permite que integrações possam consultar e enviar os anexos de clientes do Sienge. Os endpoints consultam as informações do caminho: Apoio > Pessoas > Clientes > edição do cliente > aba anexos. A estrutura é a mesma dos contratos de vendas e a figura abaixo mostra o nome dos endpoints disponíveis na nossa documentação de APIs 

• Agrupamentos de Unidades 

Esta API permite a consulta dos agrupamentos de unidades de um empreendimento no caminho Apoio > Obras/Centros de Custo > Cadastro > edição do empreendimento > aba Vendas > Seção Agrupamento de unidades. A figura abaixo mostra o nome do endpoint disponível na nossa documentação de APIs.  

• Inativação de Reservas 

Esta API permite a inativação de uma reserva de unidade no caminho Comercial > Vendas > Reserva de unidades. A figura abaixo mostra o nome do endpoint disponível na nossa documentação de APIs.  

• Inclusão de campos API – Empreendimentos 

Foram incluídos mais 32 campos na API de empreendimentos com as informações do empreendimento no caminho Apoio > Obras/Centros de Custo > Cadastro > edição do empreendimento > aba Vendas > Seção Vendas. A figura abaixo mostra o nome do endpoint disponível na nossa documentação de APIs.  

• Inclusão de campos API – Unidades 

Foram incluídos os campos de número e ID do contrato vinculado à unidade quando a mesma se encontra vendida. Essa informação possibilita que algumas consultas sejam feitas de forma mais rápida. A figura abaixo mostra o nome do endpoint disponível na nossa documentação de APIs. 

• API de comissões - Cadastro de comissão 

Esta API permite que seja feito o cadastro de uma comissão com valores de parcelas diferentes. O cadastro sendo feito na origem, não é necessário a edição manual do título no contas a pagar. A figura abaixo mostra o nome do endpoint disponível na nossa documentação de APIs. É possível enviar, atualizar e consultar as informações das parcelas com valores diferentes quando há o atributo “installments”. 

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