APIs de Unidades

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 POST de Unidade 

 

A Disponibilização deste endpoints possibilitará que outras plataformas enviem os dados de cadastros de unidades para o Sienge, além das consultas que são feitas hoje.  

 

A disponibilização dos endpoints de unidades compreendem: 

  • POST de unidade; 
  • POST de unidade filha; 
  • PUT de características das unidades. 

 

Para atender esses cadastros foram criados mais endpoints  acessórios, sendo eles: 

  • POST de características para unidades;  
  • GET de características para unidades; 
  • POST de situações para unidades; 
  • GET de situações para unidades. 

 

A figura abaixo apresenta os endpoints de unidade. 

 

Captura de tela 2023-12-13 180651 

 

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.  

 

 

 

 

 

Esperamos que este artigo tenha ajudado!



 

Isso foi útil para você? Sim Não

Enviar feedback
Desculpe-nos por não podermos ajudar. Ajude-nos a melhorar este artigo com seu feedback.