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/
Modificação API – Integrações Bancárias – Antecipação de parcelas
O endpoint de Antecipação de Parcelas é destinado para a geração de boletos de parcelas antes da sua data final de vencimento. Através desse endpoint é possível que integrações com CRMs como o Construtor de Vendas integrar com o Sienge e disponibilizar um serviço de geração de cobranças para o cliente final em seu Portal ou automação de chat.
O pré-requisito para o uso deste endpoint é a aquisição de um conector de Integração bancária Recebimentos Instantâneos ou VAN bancária.
A modificação realizada foi a exclusão da obrigatoriedade de alguns campos que serão baseados em informações cadastradas previamente no centro de custo.
Endpoint | /prepayment-slip-register |
Body | { "companyId": 1, "installments": [ { "billId": 10, "installmentId": 0 } ], "accountNumber": "6538-2", "newDueDate": "2021-01-01", "groupBy": "CUSTOMER", "matchDueDate": "ALL", "percentPresentValue": 11.11, "calculatePresentValue": true, "correctAnnualInstallment": true } |
Os campos Empresa (companyId) e Conta Corrente (accountNumber) passam a ser não obrigatórios quando no cadastro do Centro de Custo > aba Vendas > Seção Registro de Reserva o campo conta corrente estiver preenchido com uma conta vinculada aos Recebimentos Instantâneos ou VAN bancária, conforme a figura abaixo.
O uso do tipo de agrupamento por cliente obriga o preenchimento dos campos de Empresa (companyId) e Conta Corrente (accountNumber).
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!