Skip to content

Commit

Permalink
Melhorias na documentacao
Browse files Browse the repository at this point in the history
  • Loading branch information
@guicouto
guicouto committed Sep 5, 2018
1 parent e2e9e8c commit 1349611
Show file tree
Hide file tree
Showing 6 changed files with 302 additions and 2 deletions.
16 changes: 16 additions & 0 deletions docs/source/clientes/atendimento.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Atendimento ds Clientes
============

**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/financeiro

**GET**
233 changes: 233 additions & 0 deletions docs/source/clientes/consulta.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
Consulta de Clientes
============

**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

Os atributos podem conter os seguintes valores:


:busca: nome_razaosocial, nome_fantasia, cpf_cnpj, codigo_cliente, telefone, login_radius, ipv4, mac
:limit: Valor mínimo 1, Valor Máximo 50. Valor Default 5 (Ao não preencher)
:cancelado: sim, nao
:order_by: nome_razaosocial, nome_fantasia, codigo_cliente, cpf_cnpj
:order_type: asc, desc

Exemplo de requisição GET na rota de cliente::

curl -X GET --header "Accept:application/json" https://endereco_servidor/api/v1/integracao/cliente?busca=nome_razaosocial&termo_busca=guilherme&limit=2&cancelado=nao&order_by=codigo_cliente&order_type=asc -k --header "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijg0MTM2O"

Retorno da requisição GET::

{
"status": "success",
"msg": "Dados consultados com sucesso",
"clientes": [
{
"id_cliente": 11201,
"codigo_cliente": 421,
"nome_razaosocial": "GUILHERME SILVA",
"nome_fantasia": null,
"tipo_pessoa": "pf",
"cpf_cnpj": "10682083681",
"telefone_primario": "37988242968",
"telefone_secundario": "37988242968",
"telefone_terciario": "",
"rg": "MG16999888",
"rg_emissao": null,
"inscricao_municipal": null,
"inscricao_estadual": null,
"data_cadastro": "2017-08-05 00:00:00",
"data_nascmento": "1969-12-31 04:00:00",
"servicos": [
{
"numero_plano": 1,
"nome": "4M",
"valor": 119.9,
"status": "Serviço Habilitado",
"status_prefixo": "servico_habilitado",
"login": "guilhermesilva1068",
"senha": "123",
"ipv4": "10.99.2.203",
"ipv6": null,
"interface": {
"nome": "Interface Conexão Genérica",
"tipo": "wireless",
"called_sid": null
},
"equipamento_conexao": {
"nome": "GENERICO",
"ipv4": "192.168.2.100",
"ipv6": null
},
"endereco_cadastral": {
"completo": "RUA DONA MARIA DAS DORES, 541 - NOSSA SENHORA DAS GRACAS, DIVINóPOLIS/MG - IGREJA",
"logradouro": "RUA",
"endereco": "DONA MARIA DAS DORES",
"numero": "541",
"complemento": "IGREJA",
"bairro": "NOSSA SENHORA DAS GRACAS",
"cep": "35501-048",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Divinópolis"
},
"endereco_instalacao": {
"completo": "RUA MINAS GERAIS, 1793 - IPIRANGA, DIVINóPOLIS/MG",
"logradouro": "RUA",
"endereco": "MINAS GERAIS",
"numero": "1793",
"complemento": "",
"bairro": "IPIRANGA",
"cep": "35502-026",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Divinópolis"
},
"endereco_fiscal": {
"completo": "RUA GOIAS, 86 - PORTO VELHO, DIVINóPOLIS/MG - APTO 101",
"logradouro": "RUA",
"endereco": "GOIAS",
"numero": "86",
"complemento": "APTO 101",
"bairro": "PORTO VELHO",
"cep": "35500-000",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Divinópolis"
},
"endereco_cobranca": {
"completo": "RUA SEBASTIAO PARDINI, 58 - CENTRO, DIVINóPOLIS/MG - 202",
"logradouro": "RUA",
"endereco": "SEBASTIAO PARDINI",
"numero": "58",
"complemento": "202",
"bairro": "CENTRO",
"cep": "35500-000",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Divinópolis"
}
}
]
},
{
"id_cliente": 11202,
"codigo_cliente": 422,
"nome_razaosocial": "GUILHERME COSTA",
"nome_fantasia": null,
"tipo_pessoa": "pf",
"cpf_cnpj": "05333614622",
"telefone_primario": "37999450812",
"telefone_secundario": "37999452812",
"telefone_terciario": "",
"rg": "MG11298180",
"rg_emissao": null,
"inscricao_municipal": null,
"inscricao_estadual": null,
"data_cadastro": "2017-04-26 00:00:00",
"data_nascmento": "1969-12-31 00:00:00",
"servicos": [
{
"numero_plano": 1,
"nome": "24M",
"valor": 119.9,
"status": "Serviço Habilitado",
"status_prefixo": "servico_habilitado",
"login": "guilhermesouza0533",
"senha": "123",
"ipv4": "10.99.1.118",
"ipv6": null,
"interface": {
"nome": "Interface Conexão Genérica",
"tipo": "wireless",
"called_sid": null
},
"equipamento_conexao": {
"nome": "GENERICO",
"ipv4": "192.168.2.100",
"ipv6": null
},
"endereco_cadastral": {
"completo": "RUA GERALDO RODRIGUES DA COSTA, 5 - CENTRO, SANTO ANTôNIO DO MONTE/MG",
"logradouro": "RUA",
"endereco": "GERALDO RODRIGUES DA COSTA",
"numero": "5",
"complemento": "",
"bairro": "CENTRO",
"cep": "35560000",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Santo Antônio do Monte"
},
"endereco_instalacao": {
"completo": "RUA JOÃO J FERNANDES, 900 - BARRETOS, NOVA SERRANA/MG - AREA RURAL",
"logradouro": "RUA",
"endereco": "JOÃO J FERNANDES",
"numero": "900",
"complemento": "AREA RURAL",
"bairro": "BARRETOS",
"cep": "35519-000",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Nova Serrana"
},
"endereco_fiscal": {
"completo": "RUA RITA DOS SANTOS MESQUITA, 233 - SANTO AGOSTINHO, PERDIGãO/MG",
"logradouro": "RUA",
"endereco": "RITA DOS SANTOS MESQUITA",
"numero": "233",
"complemento": "",
"bairro": "SANTO AGOSTINHO",
"cep": "35545-000",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Perdigão"
},
"endereco_cobranca": {
"completo": "RUA DOIS, 221 - BARRETINHOS, NOVA SERRANA/MG - AREA RURAL",
"logradouro": "RUA",
"endereco": "DOIS",
"numero": "221",
"complemento": "AREA RURAL",
"bairro": "BARRETINHOS",
"cep": "35519-000",
"estado": "MG",
"uf": "MINAS GERAIS",
"cidade": "Nova Serrana"
}
}
]
}
]
}

No exemplo acima, foi feito uma requisição utilizando os seguintes parâmetros:

- busca: nome_razaosocial
- limit: 2 (Preciso de apenas 2 resultados)
- cancelado: nao (Quero apenas planos ativos)
- order_by: codigo_cliente
- order_type: asc (Do maior para o menor)

24 changes: 24 additions & 0 deletions docs/source/clientes/index.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Clientes
============

**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

Abaixo estão todas as funções disponíveis do cliente

.. toctree::
:caption: Funções da API de Clientes

consulta
financeiro
atendimento
ordem_servico
16 changes: 16 additions & 0 deletions docs/source/clientes/ordem_servico.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Ordem de Serviço dos Clientes
============

**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/ordem_servico

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

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

**GET**
11 changes: 11 additions & 0 deletions docs/source/duvidas.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Dúvidas sobre API do HubSoft!
===================================



.. toctree::

introducao
autenticacao
clientes/index
duvidas
4 changes: 2 additions & 2 deletions docs/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Bem-vindo à documentação da API do HubSoft. Para utilizar a API é necessári

introducao
autenticacao
clientes
atendimento
clientes/index
duvidas

0 comments on commit 1349611

Please sign in to comment.