O que é uma API?
API é a sigla para Application Programming Interface ou, em português, Interface de Programação de Aplicativos.
Trata-se de uma padronização utilizada para a comunicação, transferência e carregamento de dados entre dois sistemas, softwares ou aplicativos.
De forma prática, uma API é composta por endpoints que permitem a interação com determinados recursos. Por exemplo, um recurso de Clientes pode disponibilizar ações como:
Obter dados de um cliente;
Criar (persistir) um novo cliente;
Editar informações existentes;
Excluir um cliente.
Assim, uma API ou Recurso representa o conjunto dessas ações possíveis em um determinado contexto, como Clientes, Credores ou Títulos a Receber.
Documentação das APIs do Sienge Plataforma
A documentação das APIs do Sienge Plataforma é um conteúdo técnico, voltado principalmente para desenvolvedores.
No entanto, usuários não técnicos também podem compreendê-la, especialmente se seguirem as orientações deste documento, que busca explicar os principais termos utilizados.
Entre os conceitos abordados na documentação estão temas como:
Como interpretar endpoints;
Como utilizar métodos (GET, POST, PUT, DELETE);
Como autenticar chamadas à API;
Como realizar integrações seguras e padronizadas.
Onde acessar
A documentação de APIs é dinâmica e pode sofrer atualizações frequentes.
Você pode consultá-la sempre pelo link: Documentação das APIs do Sienge Plataforma
Alteração no endpoint GET de Antecipação de Parcelas
O endpoint de antecipação de parcelas tem como objetivo apresentar o valor da cobrança a ser antecipada antes da geração efetiva da cobrança. Esse recurso é especialmente útil em processos de simulação que podem ser implementados em aplicações conectadas ao Sienge, permitindo a visualização de valores calculados de acordo com os parâmetros configurados no sistema.
Atualmente, o endpoint utiliza o método GET para retornar os resultados.
Entretanto, para evoluirmos a estrutura de APIs e alinhar com os padrões de integração, este endpoint passará por uma alteração:
O método será alterado de GET para POST.
Haverá a inclusão de um complemento na rota do endpoint.
Atenção! Essa mudança é necessária e entrará em vigor no início de setembro/2025.
Recomendamos que as aplicações integradas sejam ajustadas antecipadamente para garantir a continuidade do funcionamento.
Estrutura atual
Método: GET
Endpoint: /prepayment-slip-register
Estrutura nova
Método: POST
Endpoint: /prepayment-slip-register/simulate
Quem pode utilizar as APIs do Sienge Plataforma?
O acesso às APIs do Sienge Plataforma está disponível apenas para clientes que utilizam o Sienge na versão Data Center (DC). Para clientes que possuem o sistema em servidor local, o uso das APIs não está disponível.
Para informações detalhadas sobre disponibilidade de recursos e planos, acesse o artigo: Quais clientes podem utilizar APIs e quais recursos do sistema estão disponíveis? – Sienge Plataforma
Esperamos que este artigo tenha ajudado!