Acerca de la API web

La API web es un marco de trabajo que se utiliza para construir servicios HTTP que llegan a una amplia gama de clientes, incluidos navegadores y dispositivos móviles.

URL base

La siguiente es la URL base:

<Protocolo>://<Nombre de dominio>:<Número de puerto>/api/v1

Inicio de sesión

Introduzca el nombre de usuario y la contraseña para obtener el token. Cuando usa Seguridad, el token se utiliza para la autorización.

Nota:  La autenticación basada en tokens es una técnica de seguridad que autentica a los usuarios que intentan iniciar sesión en un servidor, una red o algún otro sistema seguro, utilizando un token de seguridad proporcionado por el servidor.

Visión general

Solicitar

Elemento Valor
MétodoPOST
URL<Base URL>/login
ParámetrosN/A
Cabecera Tipo de contenido, Longitud de contenido
Cabecera Valor
Content-Type application/json
Cuerpo JSON
Campo Tipo de datos Comentarios
usernamestring Nombre del usuario
passwordstring Contraseña
Ejemplo

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"

}

Nota: El código de ejemplo está escrito en Java.

Respuesta

Elemento Valor
Código de estado Si la autenticación es correcta, la unidad de visualización enviará 200 (OK).
Código Notas
200 OKÉxito en la autenticación
401 UnauthorizedError al autenticar
Cabecera Contenido-Tipo, Transferir-Codificación
Cabecera Valor
Content-Type application/json
Transfer-Encoding Chunked
Cuerpo JSON
Campo Tipo de datos Notas
token string Token autenticado
Ejemplo

HTTP/1.1 200 OK

Content-Type: application/json

Transfer-Encoding: chunked

 

8e

{

    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6IlVzZXIxIiwibGV2ZWwiOjF9.eqVwAuo0KMqdggICllJVPs3IE67oHdUpo04w68md7kI"

}

0

Nota: El código de ejemplo está escrito en Java.