Skip to content

Commit

Permalink
Continuando documentacao
Browse files Browse the repository at this point in the history
  • Loading branch information
guicouto committed Aug 21, 2018
1 parent e684ccb commit bcfd1b1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/source/autenticacao.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ O exemplo acima, possui alguns prarâmetros, que serão explicados abaixo:
- password: Senha do usuário

O resultado da requisição da rota /oauth/token, será igual ao exemplo abaixo::

{
access_token:"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijg0MTM2O"
expires_in:2592000
Expand Down
26 changes: 25 additions & 1 deletion docs/source/clientes.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
Clientes
============

No momento as rotas para integração com os clientes do sistema, ainda não estão disponíveis.
**Necessário**

Para fazer requisições nos dados de clientes, é necessário que você já possua o TOKEN, conseguido na etapa (Autenticação)

As requisições de clientes, devem ser feitos na rota::

/api/v1/integracao/cliente

O endereço completo, ficará da seguinte forma::

https://endereco_do_servidor/api/v1/integracao/cliente

**GET**

No método GET, irá consultar os dados dos clientes e retornar um JSON como resposta.
Os seguintes parâmetros podem/devem ser utilizados:

- busca (Obrigatório): Tipo de busca que deseja fazer no cliente
- termo_busca (Obrigatório): Termo utilizado para fazer a busca
- limit: Limite de resultados
- cancelado: Informa se deseja trazer os cancelados ou não
- order_by: Campo que será utilizado para ordenação
_ order_type: Tipo da Ordenação


0 comments on commit bcfd1b1

Please sign in to comment.