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.
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/
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
O que tem de novo?
Alteração de API de Busca (GET) de Credor no Sienge - creditors
Realizamos algumas alterações na API de Busca (Get) de credor no Sienge acrescentando a opção de efetuar a pesquisa por mais três opções: Nome do credor, nome fantasia ou código, facilitando com isso a busca dos dados.
Também acrescentamos novas informações nesta API tais como:
Cadastro/Endereço – Endereço, número, complemento, bairro, Município, CEP.
Status do Credor - Ativo ou Desativado.
Alteração de API de Inclusão (POST) de Credor no Sienge - creditors
Realizamos algumas alterações na API de Inclusão (Post) de credor no Sienge acrescentando a opção de efetuar já inclusão das seguintes informações:
Cadastro / Fiscal - Optante pela desoneração da folha de pagamento (CPRB) nos anos*.
Complemento - Inscrição Municipal (Caso seja CNPJ).
Contatos/Telefone - Código, Tipo de telefone, principal.
Contatos/Contatos - Código, Nome, DDD, telefone, ramal, e-mail.
Representantes - Código, Nome.
Procuradores - Código, Nome, DDD, telefone, ramal, CPF, RG, Endereço, Complemento, Bairro, Município, CEP.
Criação de APIs de Alterações (PATCH/PUT) de Credor no Sienge - creditors
Pensando em atender como um todo a questão de API de Credores, realizamos também a criação de novas API´s de Alteração (Patch/Put) para efetuar alterações do cadastro do credor no Sienge:
1)API de Alteração (PATCH - bank-informations) – Atualiza informações referentes ao credor no Sienge.
Cadastro/Identificação - Tipo de pessoa, CNPJ/CPF, Razão social/Nome
Cadastro/Fiscal - Inscrição Estadual
Cadastro/Endereço - Endereço, número, complemento, bairro, Município, CEP;
Complemento - Inscrição Municipal (Caso seja CNPJ)
2)API de Alteração (PATCH - phone) – Atualiza informações referentes de telefone do credor no Sienge.
Contatos/Telefone - Tipo de telefone, principal, DDD, telefone;
3)API de Alteração (PATCH - contactId) – Atualiza informações referentes de um contato do credor no Sienge.
Contatos/Contatos - Nome, DDD, telefone, ramal, e-mail;
4)API de Alteração (PATCH - procurator) – Atualiza informações de um procurador do credor no Sienge.
Procuradores - Nome, DDD, telefone, ramal, CPF, RG, Endereço, Complemento, Bairro, número, Município, CEP.
5)API de Alteração (PUT – agentes) – Atualiza informações de representantes do credor no Sienge
Representantes - Código do Credor.
6)API de Alteração (PUT – payslip-desoneration-yearsagentes) – Atualiza informações da desoneração da folha de pagamento por ano do credor no sienge.
Desoneração - Desoneração (enviar todos os anos que quer desonerar, será limpado os anos antigos e incluído os enviados).
7)API de Alteração (PUT – active) – Ativa um credor desativado no Sienge.
8)API de Alteração (PUT – Deactivate) – Desativa um credor ativo no Sienge.
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!