Skip to main content

Módulo de Clientes

El módulo de Clientes permite acceder a la información registrada de los clientes del sistema, ya sea de forma general (listado) o específica (por ID o por documento).

Consultar listado de clientes

Función: obtener una lista paginada de clientes con sus datos básicos.

Ruta: https://{Base_URL}/api/public/v1/clients

Parámetros disponibles:

Parámetro Descripción
take Cantidad de registros a retornar (obligatorio).
skip Cantidad de registros a omitir.
birthday_from y birthday_to Rango de fechas de nacimiento (opcional).
ids[] Lista de identificadores específicos (opcional).

Pasos para ejecutar la consulta:

  1. Ingrese a {BASE_URL}/docs/api.

  2. Busque la sección Clientes → Obtiene un listado paginado de clientes con sus datos básicos

  3. En el campo take, escriba la cantidad de registros que desea obtener (por ejemplo, 10).

  4. Si desea filtrar, puede agregar birthday_from y birthday_to en formato YYYY-MM-DD.

  5. Pulse “Enviar petición”.

  6. Verifique la respuesta.
    Si todo está correcto, obtendrá un código 200 OK con los datos solicitados.

Ejemplo de respuesta:

{
  "status": "success",
  "data": {
    "items": [{
      "id": 5294,
      "full_name": "Juan Rodríguez",
      "email": "juan@example.com",
      "phone": "3012345678",
      "birthday": "1993-10-05"
    }],
    "total": 1
  },
  "trace_id": "01J..."
}

Consultar cliente por ID

Función: obtener los datos completos de un cliente específico usando su identificador.

Ruta: https://{Base_URL}/api/public/v1/clients/{id}

Pasos:

  1. En el campo de la ruta, reemplace {id} por el número de identificación del cliente (por ejemplo, 2200).

  2. Agregue el parámetro take=1.

  3. Envíe la petición.

  4. Si el cliente existe, recibirá un código 200 OK.

  5. Si el cliente no existe, obtendrá un 404 Not Found.

Ejemplo de solicitud:

GET /api/public_api/clients/2200?take=1

Ejemplo de respuesta:

{
  "status": "success",
  "data": {
    "items": [{
      "id": 2200,
      "full_name": "Alonso Estupe",
      "email": "alonso@example.com",
      "gender": "M"
    }]
  },
  "trace_id": "01J..."
}

Consultar cliente por documento

Función: buscar un cliente utilizando su número de documento.

Ruta: GET {BASE_URL}/api/public_api/clients/by_identification/{document}

Pasos:

  1. Sustituya {document} por el número del documento (por ejemplo, 103968949).

  2. Presione “Enviar petición”.

  3. Verifique el código de estado:

    • 200 OK: el cliente fue encontrado.

    • 404 Not Found: no existe ningún cliente con ese documento.

Back to top