Documentación API - Aspel SAE Existencias

Información general

• Base URL: http://192.168.0.105:5001
• Version: 1.0.0
• Tipo de Autenticación: JWT (JSON Web Token)

Autenticación

La API utiliza JWT para autenticación, primero se debe obtener el token y luego incluírlos en los headers de las peticiones.

Endpoints

1. Generar Token de Autenticación

Obtiene un token JWT válido para acceder a los endpoints protegidos.

• Endpoint: POST /api/v1/Token
• Autenticación: No requiere
• Content-Type: application/json

Request Body

{
  "nombre": "client_name",
  "contraseña": "j3h4kjh3jkh2"
}

Respuestas

HttpStatusCode 200 - Ok

{
  "token": "sdkfmlasdkfasdlfjsdalfkjasdlfksdjalfkj"
}

HttpStatusCode 400 - Bad Request

{
  "message": "mensaje de error"
}

HttpStatusCode 401 - Unauthorized

{
  "message": "mensaje de error"
}

HttpStatusCode 500 - Internal Server Error

{
  "message": "mensaje de error"
}

ejemplo con cURL

curl -X POST "{base_url}/api/v1/Token" \
     -H "Content-Type: application-json" \ 
     -d "{ "nombre": "client_name", "contraseña": "sdkfnlasdkfmasdlfkjasdlfkjasdl"}"

2. Obtener Existencias

Obtiene las existencias del almacen número 1 con su precio público.

• Endpoint: GET /api/v1/Existencias
• Autenticación: Bearer {token_jwt}
• Content-Type: application/json

Query Parameters

Respuestas

HttpStatusCode 200 - Ok

{
  "items": [
    {
      "codigo": "PROD01",
      "nombre": "Producto 1",
      "existencia": 1.5,
      "precioPublico": 1.25,
      "idAlmacen": 1,
      "nombreAlmacen": "Almacen 1"
    }
  ],
  "pageNumber": 1,
  "pageSize": 20,
  "totalItems": 1500,
  "totalPages": 75
}

HttpStatusCode 400 - Bad Request

{
  "message": "mensaje de error"
}

HttpStatusCode 401 - Unauthorized

{
  "message": "mensaje de error"
}

HttpStatusCode 500 - Internal Server Error

{
  "message": "mensaje de error"
}

ejemplo con cURL

curl -X GET "{base_url}/api/v1/Existencias?numeroPagina=1&salto=20" \
     -H "Content-Type: application-json" \ 
     -H "Authentication": Bearer <token>