Acrescentando Documentacao do Desbloqueio em Confianca

hubsoftbrasil · Nov 6, 2018 · e4503ff · e4503ff
1 parent 98e5917
commit e4503ff
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 0 deletions.
diff --git a/docs/source/clientes/desbloqueio_confianca.rst b/docs/source/clientes/desbloqueio_confianca.rst
@@ -0,0 +1,50 @@
+Clientes > Desbloqueio em Confiança
+============
+
+**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/desbloqueio_confianca
+
+**POST**
+
+No método POST, será possível efetuar o desbloqueio em confiança, pela quantidade de dias desejados.
+
+.. warning::
+
+	IMPORTANTE: O sistema vai fazer a validação da regra configurada pelo painel do administrador. Por exemplo, se a regra configurada pelo painel, estiver definido que o máximo de dias para desbloqueio for menor ou igual a 3 dias e a requisição da API, tiver um valor maior que 3, o desbloqueio não será efetuado, e uma mensagem de erro será retornada.
+
+** Atributos da Requisição **
+
+:id_cliente_servico: (OBRIGATÓRIO) Identificado único do serviço do cliente
+:dias_desbloqueio: (OBRIGATÓRIO) Quantidade de dias, a partir da data atual que o cliente ficará desbloqueado em confiança
+
+Os atributos podem conter os seguintes valores:
+
+:id_cliente_servico: (OBRIGATÓRIO) Deve conter um número inteiro maior que 0
+:dias_desbloqueio: (OBRIGATÓRIO) Deve conter um número inteiro maior que 0
+
+Exemplo de requisição POST na rota do desbloqueio em confiança::
+
+	curl -X GET --header "Accept:application/json" https://endereco_servidor/api/v1/integracao/cliente/desbloqueio_confianca -d '{"id_cliente_servico":"11000", "dias_desbloqueio":"1"}' -k --header "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijg0MTM2O"
+
+Veja que os paramêtros enviados na requisição POST devem obedecer a estrutura no formato JSON::
+
+	{
+		"id_cliente_servico":"11000",
+		"dias_desbloqueio":"1"
+	}
+
+Retorno da requisição POST::
+
+	{
+    	"status": "success",
+    	"msg": "Desbloqueio em confiança realizado com sucesso até a data 26/11/2018"
+	}
diff --git a/docs/source/clientes/index.rst b/docs/source/clientes/index.rst
@@ -20,6 +20,7 @@ Abaixo estão todas as funções disponíveis do cliente
 
     atendimento
     consulta
+    desbloqueio_confianca
     extrato_conexao
     financeiro
     ordem_servico