Apoio : Clientes - Como alterar o cadastro de cliente através de API?

Documentação Sienge

Modificado em: Sex, 23 Ago, 2024 na (o) 1:41 PM

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/

Nova API de alteração do cadastro de cônjuge e inclusão de novos campos na API de atualização de cliente

Já está disponível a nova API para substituição dos dados do cônjuge, que possibilita a alteração dos dados do cônjuge do cliente pelo método de substituição, caso seja necessário alterar somente um campo é necessário enviar todos os demais campos do cônjuge, sendo disponibilizados mais de 20 campos novos.

Atenção! É possível excluir um cônjuge enviando todos os campos em branco na API desde que o cliente não esteja vinculado a um contrato.

Com esta API, os parceiros de integração conseguem manter os dados atualizados dos cônjuges vinculados a um cliente. O endpoint criado é o /customers/{id}/spouse utilizando o método de substituição PUT conforme apresentado pela figura abaixo.

Também está disponível mais campos na API de alteração de dados do cliente, esta possibilita a alteração de mais dados de um cadastro de cliente Pessoa Física e Pessoal Jurídica. Foram incluídos mais de 20 novos campos do cadastro do cliente nesta API como nome, data de nascimento e documentos. Por meio desta API, caso algum dado em algum parceiro Sienge seja atualizado, é necessário enviar somente os campos que foram atualizados. O endpoint criado é o apresentado pela figura abaixo.

Atenção! O campo “nacionalidade” passará a ficar na estrutura de Pessoa Física da API e o campo “e-mail” passa a ficar dentro da estrutura de Pessoa Física e Pessoa Jurídica, mas as integrações que utilizam esse campo continuarão funcionando até 01/08/2023 por meio da estrutura atual.