Prima-Back
  1. Modulo Clientes
Prima-Back
  • API DOCUMENTATION
  • Principal
    • /
      GET
  • Modulo Administradores
    • Vendedores Operaciones
      • Registro de Vendedores
      • Visualizar Vendedores
      • Visualizar Vendedores por Mongo ID
      • Visualizar Vendedores por cedula
      • Actualizar Vendedor
      • Eliminar Vendedor
    • Estadisticas
      • Estadisticas de documentos
      • Visualizacion de top Vendedores
      • Visualizar Ventas por Vendedor
    • Login Administradores
      POST
    • Recuperacion de contraseña Administrador
      POST
  • Modulo Vendedores
    • Inicio de Sesión Vendedores
      POST
    • Confirmación de Cuenta
      GET
    • Solicitud de restablecimiento de contraseña
      POST
    • Restablecimiento de contraseña
      POST
  • Modulo Clientes
    • Registrar Cliente
      POST
    • Visualizar Clientes
      GET
    • Visualizar Clientes por RUC
      GET
    • Actualizar Cliente
      PATCH
    • Eliminar Cliente
      DELETE
  • Modulo Productos
    • Crear Producto
      POST
    • Visualizar Productos
      GET
    • Visualizar Productos por ID
      GET
    • Actualizar Producto
      PATCH
    • Eliminar Producto
      DELETE
  • Modulo Pedidos
    • Crear Orden
      POST
    • Visualizar Ordenes
      GET
    • Visualizar Ordenes por ID
      GET
    • Actualizar Orden
      PATCH
    • Actualizar Estado de Orden
      PATCH
    • Eliminar Orden
      DELETE
  1. Modulo Clientes

Visualizar Clientes por RUC

GET
/api/clients/{{ruc}}

🔍 GET /clients/:ruc#

Busca y retorna los datos de un cliente específico según su número de RUC.

📍 Ruta#

GET /api/clients/:ruc

📝 Descripción#

Este endpoint permite consultar la información completa de un cliente registrado, a partir de su número de RUC.
Requiere autenticación mediante token JWT y valida el formato del parámetro.

🔐 Autenticación#

Requiere token JWT válido
Cabecera: Authorization: Bearer <token>
Middleware: verificarAutenticacion

🧰 Middleware#

1.
verificarAutenticacion – Verifica token JWT
2.
validateGetClient – Valida el parámetro ruc
3.
validateRequest – Manejo de errores de validación

🔢 Parámetros#

🛣️ Path Parameters#

ParámetroTipoRequeridoDescripción
rucnumber✅Número de RUC del cliente a consultar

📥 Request Body#

No requiere body

✅ Respuestas#

✔️ 200 OK – Cliente encontrado#

{
  "status": "success",
  "code": "CLIENT_FOUND",
  "msg": "Cliente encontrado.",
  "data": {
    "Name": "string",
    "Ruc": number,
    "Address": "string",
    "telephone": number,
    "email": "string",
    "credit": "string",
    "state": "string"
  }
}

❌ Errores#

⚠️ 400 Bad Request – Parámetro inválido o faltante#

{
  "status": "error",
  "code": "MISSING_FIELD",
  "msg": "El parámetro 'ruc' es obligatorio."
}

🚫 401 Unauthorized – Token ausente o inválido#

{
  "status": "error",
  "code": "AUTH_ERROR",
  "msg": "Acceso no autorizado. Se requiere token válido."
}

🔍 404 Not Found – Cliente no encontrado#

{
  "status": "error",
  "code": "NOT_FOUND",
  "msg": "No se encontró cliente con RUC {ruc}."
}

💥 500 Internal Server Error – Error inesperado#

{
  "status": "error",
  "code": "SERVER_ERROR",
  "msg": "Ha ocurrido un error inesperado al buscar el cliente. Intente de nuevo más tarde."
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://back-prima-s-a.onrender.com/api/clients/{{ruc}}' \
--header 'User-Agent: insomnia/10.3.0' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NjI0ZjkwNzY2OWM5MDZjYTM0YThkZSIsInJvbCI6ImFkbWluIiwiaWF0IjoxNzM4NjI4MjgxLCJleHAiOjE3Mzg2NTcwODF9.0or08xMGWjpppL1Lm2dGM6yX-5Y6ozETnKFwpXPgxxE'
Response Response Example
{}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
User-Agent
string 
optional
Example:
insomnia/10.3.0
Authorization
string 
optional
Example:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NjI0ZjkwNzY2OWM5MDZjYTM0YThkZSIsInJvbCI6ImFkbWluIiwiaWF0IjoxNzM4NjI4MjgxLCJleHAiOjE3Mzg2NTcwODF9.0or08xMGWjpppL1Lm2dGM6yX-5Y6ozETnKFwpXPgxxE

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2025-04-24 17:59:01
Previous
Visualizar Clientes
Next
Actualizar Cliente
Built with