Sobre a Web API

Web API é uma estrutura usada para construir um serviço HTTP que atinge uma ampla faixa de clientes, incluindo navegadores e dispositivos móveis.

Base URL

A seguir está o Base URL:

<Protocol>://<Domain Name>:<Port Number>/api/v1

Login

Insira o nome de usuário e a senha para obter o token. Ao utilizar Segurança, o token é usado para autorização.

Observação:  A autenticação baseada em token é uma técnica de segurança que autentica os usuários que tentam fazer login em um servidor, uma rede, ou algum outro sistema seguro, usando um token de segurança fornecido pelo servidor.

Visão geral

Solicitação

Item Valor
MétodoPOST
URL<Base URL>/login
ParâmetrosN/A
Cabeçalho Tipo de conteúdo, conteúdo-comprimento
Cabeçalho Valor
Content-Type application/json
Corpo JSON
Campo Tipo de dados Observações
usernamestring Nome do usuário
passwordstring Senha
Exemplo

POST http://192.168.1.100:8000/api/v1/login HTTP/1.1

Host: localhost:8082

Content-Type: application/json

content-length: 44

{

"username":"User1",

"password":"Pass1"

}

Observação: O código do exemplo é escrito em Java.

Resposta

Item Valor
Código de status Sucesso para autenticar, a unidade do display enviará 200 (OK).
Code Notas
200 OKSucesso para autenticar
401 UnauthorizedFalha ao autenticar
Cabeçalho Tipo de conteúdo, transferência-codificação
Cabeçalho Valor
Content-Type application/json
Transfer-Encoding Chunked
Corpo JSON
Campo Tipo de dados Notas
token string Token autenticada
Exemplo

HTTP/1.1 200 OK

Content-Type: application/json

Transfer-Encoding: chunked

 

8e

{

    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IlVzZXIxIiwibGV2ZWwiOjF9.eqVwAuo0KMqdggICllJVPs3IE67oHdUpo04w68md7kI"

}

0

Observação: O código do exemplo é escrito em Java.