Introdução
Bem-vindo ao SNDesk Developers!
Neste repositório, você encontrará toda a documentação essencial para a integrtação com o SNDesk. Através de nossa API, é possível acessar as funcionalidades do nosso sistema que atendem às demandas de sua empresa e clientes. Desenvolvida conforme o padrão REST, permitindo o uso dos métodos GET, POST, PUT, PATCH e DELETE, com segurança da autentificação OAuth 2.0. Esta documentação esta organizada afim de oferecer detalhes sobre o SNDesk, explicar como pode ser feito seu uso.
Padrão REST
No SNDesk usamos um padrão de arquitetura para a API chamada de REST.
O REST abstrai os detalhes técnicos da implementação dos componentes e a estrutura de protocolo, enfocando nas funções que estes componentes exercem, nas normas para sua interação e na maneira como interpretam elementos de dados relevantes. Portanto, para solicitar, atualizar ou enviar dados ao sistema, o usuário deve efetuar um pedido HTTP a um endpoint específico. Em seguida, esse endpoint da API responde, informando sobre o estado atual do recurso solicitado. Esta resposta é enviada através de HTTP, utilizando o formato JSON para estruturar a mensagem.
Cada requisição consiste em um método HTTP, um Header, uma URI e um Body que são explicados a seguir:
O método HTTP diferencia a ação que o usuário deseja realizar pela API, sendo eles:
- GET: Ação para obter uma ou mais entidades
- POST: Ação para criar uma entidade ou executar uma ação
- PUT: Ação para atualizar todos os dados de uma entidade
- PATCH: Ação para atualizar parcialmente os dados de uma entidade
- DELETE: Ação para remover uma entidade
Header: Define o caminho onde a requisição irá ocorrer, por exemplo, em uma requisição para obtenção dos dados de produtos, a URI seria: /Api/v3/produtos.
URI: Define o caminho onde a requisição irá ocorrer, por exemplo, em uma requisição para obtenção dos dados de produtos, a URI seria: /Api/v3/produtos.
Body: É o corpo da requisição, nele são informados os dados que serão enviados para o sistema e também são retornadas as informações da resposta de uma requisição.