Continuando documentação

hubsoftbrasil · Aug 21, 2018 · 609d2a9 · 609d2a9
1 parent 9fc2835
commit 609d2a9
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 3 deletions.
diff --git a/docs/source/atendimento.rst b/docs/source/atendimento.rst
@@ -0,0 +1,4 @@
+Atendimento
+============
+
+No momento as rotas para integração com os atendimentos do sistema, ainda não estão disponíveis.
diff --git a/docs/source/clientes.rst b/docs/source/clientes.rst
@@ -0,0 +1,4 @@
+Clientes
+============
+
+No momento as rotas para integração com os clientes do sistema, ainda não estão disponíveis.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,9 +8,6 @@ Documentação da API do HubSoft!
 
 Bem-vindo à documentação da API do HubSoft. Para utilizar a API é necessário que você tenha em mãos as seguintes informações: Endereço do Servidor, Client Secret, Client Id, Username e Password. Com esses dados em mãos, será possível fazer autenticação via oAuth2, para utilizar a API
 
-Guia
-ˆˆˆˆˆˆ
-
 .. toctree::
 
    introducao

diff --git a/docs/source/introducao.rst b/docs/source/introducao.rst
@@ -0,0 +1,20 @@
+Introdução
+============
+
+HubSoft é um sistema voltado para empresas de telecomunicação. A ideia de liberar a API do sistema, torna todos os processos de integração / comunicação mais dinâmicos, tornando as rotinas das empresas mais simples e ágeis.
+
+Com intuito de sempre inovar, a API do HubSoft foi construída em cima das tecnologias mais recentes do mercado. A troca de mensagens com a API é feita através do HTTP (Hypertext Transfer Protocol) utilizando o estilo arquitetural REST (Representation State Transfer).
+
+Exemplos::
+	
+	https://example.com/produto/1234
+
+Ao fazer uma chamada na rota acima utilizando o método GET, estaremos fazendo a consulta do produto de código 1234.
+Porém ao fazer a chamada na mesma rota, utilizando o método DELETE, estaremos enviando a instrução para que a API faça a remoção do produto 1234.
+
+Dessa forma, todas as funções do CRUD estarão dipsoníveis pela API, através dos métodos:
+
+- GET (Consultar)
+- POST (Adicionar)
+- PUT (Editar)
+- DELETE (Apagar)