Wiki source code of Autenticação
Version 2.1 by WBS Tecnologia on 2020/12/29 11:43
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 | ((( | ||
| 16 | = Detalhes da Rota = | ||
| 17 | |||
| 18 | (% class="box infomessage" %) | ||
| 19 | ((( | ||
| 20 | Rota: /Sistema/Seguranca/Autenticar | ||
| 21 | ))) | ||
| 22 | |||
| 23 | * Parâmetros: | ||
| 24 | ** Somente o Corpo | ||
| 25 | * Requer Autenticação: **Não** | ||
| 26 | * Método: **POST** | ||
| 27 | * Tipo de Retorno**: Void | TObjeto** | ||
| 28 | |||
| 29 | == Códigos de Status == | ||
| 30 | |||
| 31 | * 403 = Usuário ou Senha Incorretos | ||
| 32 | * 500 = Erro Interno do Servidor | ||
| 33 | * 200 = OK | ||
| 34 | * 404 = Rota Incorreta | ||
| 35 | |||
| 36 | = Detalhes da Ação = | ||
| 37 | |||
| 38 | 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. | ||
| 39 | |||
| 40 | == Payload == | ||
| 41 | |||
| 42 | Se a ação receber um conteudo "Payload", aqui deve ser descrito este conteudo, com campos e validações. | ||
| 43 | |||
| 44 | * Content-Type: application/json | ||
| 45 | |||
| 46 | {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}} | ||
| 47 | { | ||
| 48 | "Email": "winbooks@winbooks.com.br", | ||
| 49 | "Senha": "0806" | ||
| 50 | } | ||
| 51 | {{/code}} | ||
| 52 | |||
| 53 | === Campos e Validações === | ||
| 54 | |||
| 55 | |=Campo|=Descrição / Validação|=Valor Padrão | ||
| 56 | |Email|[Obrigatório] Email para a Autenticação| | ||
| 57 | |Senha|[Obrigatório] Senha para a Autenticação| | ||
| 58 | | | | | ||
| 59 | |||
| 60 | == (% style="font-size:29px" %)Detalhes do Resultado(%%) == | ||
| 61 | |||
| 62 | Este é o Payload do resultado caso a ação tenha sucesso: | ||
| 63 | |||
| 64 | {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}} | ||
| 65 | { | ||
| 66 | "Codigo": 200, | ||
| 67 | "Token": "b9fcb2ad-df28-43db-9c8f-1b2c1b82ecf4", | ||
| 68 | "Mensagens": null | ||
| 69 | } | ||
| 70 | {{/code}} | ||
| 71 | |||
| 72 | == Campos == | ||
| 73 | |||
| 74 | |=Campo|=Descrição | ||
| 75 | |Codigo|200 = Sucesso na Autenticação | ||
| 76 | |Token|Token de Acesso a API | ||
| 77 | |Mensagens|Mensagens de Erro | ||
| 78 | ))) | ||
| 79 | |||
| 80 | (% class="col-xs-12 col-sm-4" %) | ||
| 81 | ((( | ||
| 82 | {{box title="**Índice**"}} | ||
| 83 | {{toc/}} | ||
| 84 | {{/box}} | ||
| 85 | |||
| 86 | {{box}} | ||
| 87 | **Exemplos** | ||
| 88 | |||
| 89 | * Exemplo de Payload: BAIXAR | ||
| 90 | * Exemplo de Resultado: BAIXAR | ||
| 91 | {{/box}} | ||
| 92 | ))) | ||
| 93 | ))) | ||
| 94 | |||
| 95 |