Wiki source code of Autenticação

Last modified by WBS Tecnologia on 2020/12/29 12:12

version	line-number	content
1.1	1	(% class="jumbotron" %)
	2	(((
	3	(% class="container" %)
	4	(((
	5	= Autenticação e Autorização =
	6
	7	Antes de utilizar as funções da API é necessário realizar a Autenticação e recuperar o TOKEN de Acesso, que será utilizado em todas as outras requisições para autorizar o acesso.
	8	Para isto basta realizar a seguinte requisição na API
	9	)))
	10	)))
	11
	12	(% class="row" %)
	13	(((
	14	(% class="col-xs-12 col-sm-8" %)
	15	(((
6.1	16	(% class="wikigeneratedid" %)
	17	= [[image:1609243866913-508.png\|\|height="408" width="753"]] =
	18
1.1	19	= Detalhes da Rota =
	20
	21	(% class="box infomessage" %)
	22	(((
	23	Rota: /Sistema/Seguranca/Autenticar
	24	)))
	25
	26	* Parâmetros:
	27	** Somente o Corpo
	28	* Requer Autenticação: Não
	29	* Método: POST
	30	* Tipo de Retorno: Void \| TObjeto
	31
	32	== Códigos de Status ==
	33
	34	* 403 = Usuário ou Senha Incorretos
	35	* 500 = Erro Interno do Servidor
	36	* 200 = OK
	37	* 404 = Rota Incorreta
	38
	39	= Detalhes da Ação =
	40
	41	Antes de utilizar as funções da API é necessário realizar a Autenticação e recuperar o TOKEN de Acesso, que será utilizado em todas as outras requisições para autorizar o acesso.
	42
	43	== Payload ==
	44
	45	Se a ação receber um conteudo "Payload", aqui deve ser descrito este conteudo, com campos e validações.
	46
	47	* Content-Type: application/json
	48
	49	{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
	50	{
	51	"Email": "winbooks@winbooks.com.br",
	52	"Senha": "0806"
	53	}
	54	{{/code}}
	55
	56	=== Campos e Validações ===
	57
	58	\|=Campo\|=Descrição / Validação\|=Valor Padrão
	59	\|Email\|[Obrigatório] Email para a Autenticação\|
	60	\|Senha\|[Obrigatório] Senha para a Autenticação\|
	61	\| \| \|
	62
	63	== (% style="font-size:29px" %)Detalhes do Resultado(%%) ==
	64
	65	Este é o Payload do resultado caso a ação tenha sucesso:
	66
	67	{{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
	68	{
	69	"Codigo": 200,
	70	"Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4",
	71	"Mensagens": null
	72	}
	73	{{/code}}
	74
	75	== Campos ==
	76
	77	\|=Campo\|=Descrição
	78	\|Codigo\|200 = Sucesso na Autenticação
	79	\|Token\|Token de Acesso a API
	80	\|Mensagens\|Mensagens de Erro
	81	)))
	82
	83	(% class="col-xs-12 col-sm-4" %)
	84	(((
	85	{{box title="Índice"}}
	86	{{toc/}}
	87	{{/box}}
	88	)))
	89	)))
	90
3.1	91	O Token será utilizado em outros requisições dentro do Header "API_TOKEN" para autorizar a requisição:
	92
	93	[[image:1609242196305-427.png]]
6.1	94
	95	Importante: O Token é inválido depois de 30 minutos sem utilização!