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 GET de Locação de Imóveis
A disponibilização deste endpoint possibilitará que sejam feitas consultas aos contratos de locações de imóveis cadastrados no Sienge. Será possível incluir este endpoint em consultas para BIs e outras plataformas consultem os dados de cadastros de contratos de locações.
A figura abaixo apresenta o endpoint de locação de imóveis.
Os filtros disponíveis são:
Empresa
Empreendimento
Contrato
Unidade
Cliente
Situação do contrato
O retorno da API trás os seguintes dados:
Informações gerais do contrato
Unidades do contrato
Clientes do contrato
Condição de pagamento cadastrada
Informações de reajuste do contrato
Informações de encerramento do contrato
Acréscimos de mora do contrato
Desconto do contrato
Dica! 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!