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 REST – Credores 

Foram adicionados três novos endpoints na API REST de Credores. Abaixo, estão detalhados os endpoints com suas respectivas informações. 

A documentação completa e técnica pode ser acessada em: https://api.sienge.com.br/docs/#/creditor-v1

API POST – Registro de informações bancárias do credor – Contas a Pagar  

A API POST /creditors/{creditorId}/bank-informations permite a inserção das informações bancárias do credor em seu cadastro. Dessa forma, é possível informar dados bancários como banco, agência, número e dígito da conta, tipo de conta, beneficiários, entre outras informações. 

Sendo assim, o cliente consegue informar todos os dados bancários de um credor sem acessar o seu cadastro diretamente pelo Sienge. 

API GET – Consulta de informações bancárias do credor – Contas a Pagar  

A API GET /creditors/{creditorId}/bank-informations permite a consulta das informações bancárias dos credores. Com isso, o cliente consegue fazer uma chamada nessa API para listar informações como banco, agência, CPF/CNPJ, número da conta, entre outras informações. 

Portando, as informações bancárias do credor podem ser acessadas facilmente via API. Não sendo mais necessário efetuar login na plataforma para buscar os dados. 

API PATCH – Alteração de informações bancárias do credor – Contas a Pagar  

A API PATCH /creditors/{creditorId}/bank-informations/{banckInformationId} permite realizar a alteração das informações bancárias dos credores. Assim, é possível que dados como banco, agência, número e dígito da conta, tipo de conta, nome do beneficiário, entre outras informações, sejam alteradas. 

Da mesma forma que a API GET e a POST descritas anteriormente, a API PATCH tem como objetivo facilitar o uso dos usuários na utilização das APIs. Não sendo mais necessário, obrigatoriamente, acessar o Sienge para realizar alterações nas informações bancárias dos credores. 

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!